3 ms·
If you are writing starting a project or writing it for yourself, this is great advice. If you aspire to have it used by other people, it is still good advice,
by afarrell 9y ago
If you are writing starting a project or writing it for yourself, this is great advice.
If you aspire to have it used by other people, it is still good advice, but only a first step. The next step is to test the documentation. Have someone run through your intro tutorial and see both:
- How hard is the tutorial to work through
- How well does it help them build a mental model of the major interfaces of the project.