| Type |
Level | MID | UID | PREFIX | REFS |
Title |
Statement |
Rationale |
Comment |
|
TEXT
|
|
|
|
|
|
|
All BioFlow product requirements live here, authored in
StrictDoc.
|
|
|
|
SECTION
|
1
|
|
|
|
|
Layout |
|
|
|
|
TEXT
|
|
|
|
|
|
|
srs.sdoc — Software Requirements Specification. All requirements of
every type live here, distinguished by the TYPE field (functional,
performance, interface, ui, data, alarm, installation, usability,
regulatory, constraint, safety, security).
tests/unit.sdoc — Unit test specifications (prefix UT-).
tests/integ.sdoc — Integration test specifications (prefix IT-).
tests/sys.sdoc — System test specifications (prefix ST-).
strictdoc_config.py — StrictDoc project configuration.
|
|
|
|
SECTION
|
2
|
|
|
|
|
Authoring |
|
|
|
|
TEXT
|
|
|
|
|
|
|
Each .sdoc document's [GRAMMAR] block enforces field shapes, the TYPE
vocabulary, and the typed-link roles at parse time. Start there when
authoring a new item.
Change records for edits to baselined items live in changes/ (see
changes/README.md).
|
|
|
|
SECTION
|
3
|
|
|
|
|
Running StrictDoc |
|
|
|
|
TEXT
|
|
|
|
|
|
|
Developer-facing install, export, web-UI, version-bump, and SOUP details
are in dev-docs/strictdoc.md. Short version:
uv sync # install
uv run strictdoc export reqs/ --output-dir reqs/output # export HTML
|
|
|