Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

2024-Q3/Q4: Documentation train #1911

Open
7 of 29 tasks
stanislaw opened this issue Jul 7, 2024 · 0 comments
Open
7 of 29 tasks

2024-Q3/Q4: Documentation train #1911

stanislaw opened this issue Jul 7, 2024 · 0 comments
Labels
Documentation Improvements or additions to documentation Second roadmap
Milestone

Comments

@stanislaw
Copy link
Collaborator

stanislaw commented Jul 7, 2024

Previous train: #1756
Next train: TBD


  • Design issue: single vs multiline fields. Define them in grammar instead of relying on the content field idx?
  • ReqIF / New default profile.
  • Single-line source file links.
  • 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.
  • 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)
  • 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.
  • How long has the StrictDoc project been around? -- Redirect to dev plan.
@stanislaw stanislaw added Documentation Improvements or additions to documentation Second roadmap labels Jul 7, 2024
@stanislaw stanislaw added this to the 2024-Q3 milestone Jul 7, 2024
@stanislaw stanislaw changed the title 2024-Q3: Documentation train 2024-Q3/Q4: Documentation train Oct 13, 2024
@stanislaw stanislaw modified the milestones: 2024-Q3, 2024-Q4 Oct 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Improvements or additions to documentation Second roadmap
Projects
None yet
Development

No branches or pull requests

1 participant