Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Generate T2WML Web Documentation #565

Open
kyao opened this issue Jul 22, 2021 · 4 comments
Open

Generate T2WML Web Documentation #565

kyao opened this issue Jul 22, 2021 · 4 comments
Assignees
Milestone

Comments

@kyao
Copy link
Collaborator

kyao commented Jul 22, 2021

Generate T2WML Web Documentation based the format specified by the program. For sample documentation, see the "Enhanced Document Editor" documentation.

Required sections include:

  1. Introduction
  2. Status
  3. CONOPS
  4. Scope
  5. Epics & User Stories
  6. Requirements
  7. User Experience Design
  8. Technical Design
  9. Data Model
  10. Test Considerations
  11. Reporting
@kyao kyao added this to the Milestone 4 milestone Jul 22, 2021
@g1eb
Copy link
Contributor

g1eb commented Jul 24, 2021

@kyao where can I find the Enhanced Document Editor documentation that you mentioned above?

@g1eb g1eb self-assigned this Aug 3, 2021
@g1eb
Copy link
Contributor

g1eb commented Aug 3, 2021

For this week @kyao is going to generate 1 sentence epics/ user stories.

For next week milestone 4 we're going to look into hosting a docs folder with .md files describing the user stories and how they work, providing some context and illustrating functionality with relevant screenshots.

@g1eb g1eb assigned kyao Aug 3, 2021
@g1eb
Copy link
Contributor

g1eb commented Sep 20, 2021

Ke-Thia created a template in MS Word with an initial set of headings, I just need to fill in the gaps with content, screenshots and add annotations/descriptions of the elements in the pictures.

@g1eb
Copy link
Contributor

g1eb commented Oct 5, 2021

@kyao is there anything else we need to add the the t2wml-web documentation?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants