Systems/Software Engineering Document Templates (DIDs) in PDF and HTML
- Open 498-STD.PDF in the pdf directory to get started
- See the 498-INFO.pdf for the original announcement
- HTML format DIDs in git submodule
- Or try one of the GitHub template repos (see below)
Clone with the following to get the submodule:
$ git clone --recurse-submodules https://github.com/VCTLabs/MIL-STD-498.git
For a nice overview of why this is still relevant, see this link.
Github template repos for a handful of DIDs with easy-to-consume DID in
ASCII text format and the associated document shell in reStructuredText
format. Includes rst style bits and example title pages/system diagram
(the latter generated with a nice little Python script). Build your
document with make or Tox! How cool is that?
Note
More document automation is in progress, in particular support for test case automation. Feel free to contribute via Github!
| SUM: | System / Software User Manual - an actual user guide |
|---|---|
| SVD: | System / Software Version Description - detailed release document |
| STD: | System / Software Test Description - test cases and procedures, traceability matrix |
| STR: | System / Software Test Report - test analysis and results |
| timew-addons-sum: | Software User Manual for timew-addons (still WIP) |
|---|
If you happen to have public repository consuming one of the templates, please file an issue to let us know about it!
The GuideBook is published in several parts:
- Overview and Tailoring Guide - 498GBOT.pdf
- Application and Reference Guide - 498GBAR.pdf
- Application and Reference Guide Sec. 5 - 498GBAR5.pdf
- Application and Reference Guide App. A - 498ARAPX.pdf
Note the above Guidebook URIs are local file links.