RFC: StrictDoc's documentation traceability structure

[stanislaw]

Hello everyone,

We are exploring the final to-be-qualified structure of StrictDoc documentation. The documents are already there, we are mostly figuring at which level the documents should be, and it looks like we settled with how the arrangement could work best.

A few key comments:

• The 'spine' of the whole specification is L1-L2 (writing this, I am thinking that it is a pretty medical analogy because the Ls are like vertebrae. In fact, L1 could be split into two but we are doing it flat just to save the effort).

• The documents Dev Plan, Dev Guide, Feature Map, and Design do not contribute core requirements. Instead, they trace forward and backward to L1, L2, and the source code, providing more text-based but still traceable commentary to help users navigate the information.

• Quality- and development process-related requirements are directly allocated to the dedicated chapters of L1 and L2. L1 and L2 act as the 'spine,' while these four documents serve as extended commentary.

• As a rule of thumb, the commentary docs will be extensively supplemented with diagrams and high-level summaries to assist in understanding the L1–L2–source flowdown.

• The medical requirements towards StrictDoc do not exist yet but should become available from a user in the near future.

The screenshot demonstrates the v0 of the structure we have in mind. We will be increasing the tracing between all the documents and exploring if the structure needs to be adjusted.

Any feedback is appreciated. I will keep this topic on the office hours backlog for some time until we have everything finalized.

[stanislaw]

cc @haxtibal @johanenglund @thseiler @richardbarlow @philippatsirgiotis @nicpappler @kestewart