2025: Documentation train

[stanislaw]

Previous train: #1911
Next train: TBD

---

• backend/sdoc_source_code: add more traceability links with L2 #2356
• Conventional commits.
• User guide: MultipleChoice vs Tag. See UI: autocomplete-for-tags #2273 (comment).
• Testing: SDoc's own documentation. SDoc's reqs in SDoc.
• Design issue: single vs multiline fields. Define them in grammar instead of relying on the content field idx? RFC: Improving the handling of single-line and multi-line strings in StrictDoc #2221
• ReqIF / New default profile.
• Two workflows: CLI and UI.
• Composable documents: assets path resolution.
• FAQ: Related tools: Capella, Gaphor.
• ReqIF: Export/Import Wizard.
• ReqIF: describe scripting examples.
• FAQ: Does StrictDoc have to only have the text markup?
• Design document: Dealing with empty fields.
• RST guide: what is supported and not #1353, RST markup basic examples. Related: https://asciiflow.com/#/
• https://www.hackster.io/jens6151/bicycle-computer-on-spresense-b0e332
• 304 handling (assets and docs)
• Why feature toggles? (edge cases)
• The SDoc in-memory model is converted to an Excel XLSX file using the XlsWriter library (end with a dot).

L1/L2

• Single-line source file links.
• Parsing source nodes.
• Delete node -> delete_requirement.py
• Traceability matrix -> traceability_matrix_screen.js
• Tool identification feature L1/L2 -> about_command.py, version_command.py
• L1: Distribution requirement: static/PyInstaller/binary.
• L1: 1.4. Target audience, create subsections, remove bold titles.
• Docker L1/L2
• Level == None L2 requirement.
• L2: Buttons to copy text to buffer - JS file.
• Diff feature -> diff_command.py , many itests
• Project statistics -> document_stats.py
• Search / Query engine -> query_engine/
  • Static HTML search bar vs Search screen.
• Doxygen generator -> doxygen_generator.py
• Mermaid -> mermaid.min.js
• Project map -> project_map.py, project_map.jinja.js

Dev plan / quality

• Requirements dev plan: tests are linked to requirements directly.
• Quality mechanism: Tracking Bug tickets with https://github.com/strictdoc-project/strictdoc/issues?q=is%3Aissue%20state%3Aopen%20type%3ABug.
• Dev Plan: deliberate use of asserts.
• Exceptions to code coverage: raise NotImplementedError/AssertionError, PyInstaller/Nuitka, Windows.

Dev guide

• Dev guide: Git titles: when to not use subject. Simple sentences are enough.
• Dev guide: document the ## multiline comments.
• Dev guide: The use of @properties is discouraged. @Property vs is_*() and get_*() methods.
• Dev guide: CRUD conventions
• Dev guide: document the capitalization and dots in comments.
• Dev guide: Let's have the comment above the line. StrictDoc most of the time does not have the right-side comments, except when they are about mypy, ruff, coverage, etc.
• Dev guide: European capitalization and Proper Nouns. Proper capitalization of words like Git, Chrome, JavaScript.
• Dev guide: discourage defaultdict.
• Dev guide: All comments shall be capitalized.
• Dev guide: Document -t from Enable running single e2e test Enable running single e2e test #2072.
• L1: Developer guide.

---

• Traceable development plan. Which function does it have along with L1 and L2?
• Traceable design document.