I’ve heard that styled as “do project the document,
don’t document the project” but I don’t
know a source to attribute this to.
The idea is to write a rough draft that covers what the project is, what it does, the API structure, and how to
use the project, then write the code, “projecting the document”, and finally sort out the documentation -
comments in the source, everything else in a manual page,
article, or research paper.
The idea is to write a rough draft that covers what the project is, what it does, the API structure, and how to use the project, then write the code, “projecting the document”, and finally sort out the documentation - comments in the source, everything else in a manual page, article, or research paper.