I approve of you making the overall documentation files at the top of the project. That's very very good practice indeed! However...
I recommend making the parts of the documentation that are not exact technical phrases be set in a variable-width font. For example (in TechnicalManual.docx):
\src — contains all the source files, <*.h> libraries of the project and the main.cpp file. In particular, \src directory contains several subfolders with project libraries:
would be better as:
\src — contains all the source files, <*.h> libraries of the project and the main.cpp file. In particular, \src directory contains several subfolders with project libraries:
It makes the different parts "pop" correctly to the eye of the reader-in-a-hurry. The more complicated the document, the more important it is to get these sorts of things right. Particular attention needs to be paid to "technical phrases" (things you might cut-n-paste into a terminal) and terms from a controlled vocabulary (more especially vital when working with standards and conformance documentation; I didn't notice any of that in your current docs but I didn't go through in depth).
I approve of you making the overall documentation files at the top of the project. That's very very good practice indeed! However...
I recommend making the parts of the documentation that are not exact technical phrases be set in a variable-width font. For example (in
TechnicalManual.docx):would be better as:
It makes the different parts "pop" correctly to the eye of the reader-in-a-hurry. The more complicated the document, the more important it is to get these sorts of things right. Particular attention needs to be paid to "technical phrases" (things you might cut-n-paste into a terminal) and terms from a controlled vocabulary (more especially vital when working with standards and conformance documentation; I didn't notice any of that in your current docs but I didn't go through in depth).