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

Create documentation templates #97

Open
6 tasks
capsulecorplab opened this issue Nov 19, 2018 · 0 comments
Open
6 tasks

Create documentation templates #97

capsulecorplab opened this issue Nov 19, 2018 · 0 comments
Assignees
Labels
devops Development operations enhancement New feature or request _operations General operational tasks - includes management, administration, logistics, HR, etc

Comments

@capsulecorplab
Copy link
Contributor

capsulecorplab commented Nov 19, 2018

Completion of this task will entail a complete profile of documentation templates, and associated style guides, for facilitating knowledge capture for systems engineering. using a markup language supported by GitHub. Primary candidate in consideration for this implementation is AsciiDoc as it's the recommended markup language for technical writing (see What is AsciiDoc? Why do we need it?), and a more preferred alternative to markdown. The full profile of documents to be templatized shall include:

  • Engineering Design Report (EDR)
  • Engineering Analysis Report (EAR)
  • Standard Operating Procedure (SOP)
  • Concept of Operations (ConOps)
  • Software Requirements Specifications (SRS)
  • Tradestudy

Relevant resources:

This task is part of Epic #89

@capsulecorplab capsulecorplab self-assigned this Nov 19, 2018
@capsulecorplab capsulecorplab added devops Development operations _operations General operational tasks - includes management, administration, logistics, HR, etc enhancement New feature or request needs points labels Nov 19, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
devops Development operations enhancement New feature or request _operations General operational tasks - includes management, administration, logistics, HR, etc
Projects
None yet
Development

No branches or pull requests

2 participants