Software for writing technical requirements and specifications.
Project description
StrictDoc
StrictDoc is software for writing technical requirements and specifications.
Summary of StrictDoc features:
- The documentation files are stored as human-readable text files.
- A simple domain-specific language DSL is used for writing the documents. The text format for encoding this language is called SDoc (strict-doc).
- StrictDoc reads
*.sdoc
files and builds an in-memory representation of the document tree. - From this in-memory representation, StrictDoc can generate the documentation into a number of formats including HTML, RST, PDF, Excel.
- The focus of the tool is modeling requirements and specifications documents. Such documents consist of multiple statements like "system X shall do Y" called requirements.
- The requirements can be linked together to form the relationships, such as "parent-child", and from these connections, many useful features, such as Requirements Traceability and Documentation Coverage, can be derived.
- Good performance of the textX parser and parallelized incremental generation of documents: generation of document trees with up to 2000-3000 requirements into HTML pages stays within a few seconds. From the second run, only changed documents are regenerated. Further performance tuning should be possible.
Warning: The StrictDoc project is alpha quality. See the Roadmap section to get an idea of the overall project direction.
The documentation is hosted on Read the Docs: StrictDoc documentation.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
strictdoc-0.0.11.tar.gz
(80.6 kB
view hashes)
Built Distribution
strictdoc-0.0.11-py3-none-any.whl
(106.3 kB
view hashes)
Close
Hashes for strictdoc-0.0.11-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | da8078857e460cf8afc8f19a7a4e3a60b4487bb248bb89a48b7d73d04921d674 |
|
MD5 | 10e9b5dcaa4c0f9c51c97692a09f8cff |
|
BLAKE2b-256 | 25c91eb5df17898679c5b5df71d2ec2533bef14481a69db9e0f14d20a7f4cb7c |