strictdoc 0.24.0

StrictDoc is open-source software for technical documentation and requirements management.

StrictDoc

StrictDoc is open-source software for technical documentation and requirements management.

Documentation

The main StrictDoc documentation is hosted on Read the Docs:

The documentation is hosted on Read the Docs: StrictDoc documentation.

For a quick visual overview, see the StrictDoc project slide deck.

Installation

StrictDoc requires Python 3.10 or newer.

pip install strictdoc

See the StrictDoc user guide section of the Read the Docs site for more details.

Quick start

Create a small hello_world.sdoc file:

[DOCUMENT]
TITLE: StrictDoc

[REQUIREMENT]
UID: SDOC-HIGH-REQS-MANAGEMENT
TITLE: Requirements management
STATEMENT: StrictDoc shall enable requirements management.

Export it to static HTML:

strictdoc export .

Or run the local web server:

strictdoc server .

StrictDoc starts the server on http://127.0.0.1:5111 by default.

Project links

• Documentation: https://strictdoc.readthedocs.io/en/stable/
• Source code: https://github.com/strictdoc-project/strictdoc
• Examples: https://github.com/strictdoc-project/strictdoc-examples
• Templates: https://github.com/strictdoc-project/strictdoc-templates

License

StrictDoc is licensed under the Apache License 2.0. See LICENSE for details.