3 ms·
If this wasn't sarcastic, it probably should have been. There is no perfect documentation, because you can't predict your audience. I document code in such a w
by bluejekyll 9y ago
If this wasn't sarcastic, it probably should have been.
There is no perfect documentation, because you can't predict your audience. I document code in such a way as to make it easier for myself to go back to it. I've kicked myself too many times to count where I didn't document something; went back to code, found it confusing, went to find out who wrote it only to discover it was me.
Document your code for yourself.
- afarrell 9y agoIf 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.