Overview¶
Github does not support include
.
You can find a rendered version on
readthedocs.
Purpose¶
The doc
folder
- motivates to use light markup text, specifically restructuredText, over DOCX or ODT for documentation of software projects
- is an example documentation using rstdoc, a wrapper around Sphinx and Pandoc
For your project documenation a readme
- gives an overview of the documents: Files
- summaries dependencies between the documents: Dependencies
Files¶
readme.rest¶
readme.rest
provides an overview of the documentation,
such that new team members or reviewers can find their way in the documentation.
No actual content is placed in the readme.rest
file.
ra.rest¶
Motivations and risks.
The argumentation is kept general to motivate general requirements that do not presume solutions.
dd.rest¶
The detailed choices made to satisfy System Requirements.
Here the actual format, the conventions and the tools are proposed.
Dependencies¶
FCA diagram of dependencies with clickable nodes: ra lightblue, sr red, dd yellow, tp green
tr0: |
---|
dhy, r1p, Sustainability, r8d, r90, r9g, Community, Parallelism, Traceability, rj4, Redundancy, Formatting vs Content, rstdcx, Accessibility, Automation, Productivity, s0t, s10, s1g, s45, s8c, scs, seo, sgt, sim, System Requirements, sxr, test_lnkname
Up: tr2, tr4, tr5, tr7, tr8, tr10, tr12, tr13, tr14, tr15, tr16, tr17
Down:
tr1: |
---|
Up:
Down: tr3, tr6, tr9, tr11, tr14, tr15, tr16, tr17
tr2: |
---|
Up: tr3
Down: tr0
tr3: |
---|
Up: tr1
tr4: |
---|
Sustainability, r9g, Community, Traceability, rj4, Formatting vs Content, rstdcx, Accessibility, Productivity, s45, sgt
Down: tr0
tr5: |
---|
Up: tr3
Down: tr0
tr6: |
---|
Up: tr1
tr7: |
---|
Up: tr6
Down: tr0
tr8: |
---|
Up: tr6
Down: tr0
tr9: |
---|
Up: tr1
tr10: |
---|
r1p, Redundancy, sgt
Down: tr0
tr11: |
---|
Up: tr1
tr12: |
---|
r8d, Redundancy, s8c
Up: tr11
Down: tr0
tr13: |
---|
Up: tr11
Down: tr0
tr14: |
---|
Up: tr1
Down: tr0
tr15: |
---|
Up: tr1
Down: tr0
tr16: |
---|
Up: tr1
Down: tr0
tr17: |
---|
System Requirements, test_lnkname
Up: tr1
Down: tr0