strictdoc icon indicating copy to clipboard operation
strictdoc copied to clipboard

2024-Q2: Documentation train

Open stanislaw opened this issue 1 year ago • 0 comments

Previous train: https://github.com/strictdoc-project/strictdoc/issues/1562 Next train: TBD


  • [ ] L1: Tool identification (about).
  • [ ] L2: Buttons to copy text to buffer - JS file.
  • [ ] Level == None L2 requirement.
  • [ ] Note on documents portability, similar concerns as with the C portability.
  • [ ] Two workflows: CLI and UI.
  • [ ] Composable documents: assets path resolution.
  • [ ] Distribution requirement: PyInstaller/binary.
  • [ ] FAQ: Related tools: Capella, Gaphor.
  • [ ] Requirements dev plan: tests are linked to requirements directly.
  • [ ] CRUD conventions
  • [ ] DevGuide: Avoid req, buf, doc...
  • [ ] ReqIF: Export/Import Wizard.
  • [ ] ReqIF: describe scripting examples.
  • [ ] Backlog: Inline link to Document [LINK: DOC_UID...].
  • [ ] Backlog: Links to Sections/Requirements/Documents from all [REQUIREMENT]'s multiline fields.
  • [ ] Document ><STATEMENT for single- vs multiline.
  • [ ] FAQ: Does StrictDoc have to only have the text markup?
  • [ ] Design document: Dealing with empty fields.
  • [ ] https://github.com/strictdoc-project/strictdoc/issues/1353, RST markup basic examples. Related: https://asciiflow.com/#/
  • [ ] https://www.hackster.io/jens6151/bicycle-computer-on-spresense-b0e332
  • [ ] 304 handling (assets and docs)
  • [ ] Interfacing with Valispace, ValispacePythonAPI#22
  • [ ] 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).
  • [ ] Feature status summary.
  • [ ] 1.4. Target audience, create subsections, remove bold titles.

stanislaw avatar Apr 06 '24 10:04 stanislaw