3 ms·
I once read some useful advice to think of documentation in four categories: For work: 1. Playbook (how to do this thing) 2. Reference (what or where is this
by zestyping 7y ago
I once read some useful advice to think of documentation in four categories:
For work:
1. Playbook (how to do this thing)
2. Reference (what or where is this thing)
For learning:
3. Tutorial (practical familiarity)
4. Explanation (deep understanding)
I agree that a lot of projects would benefit from more effort in category 4. It might be the most difficult of all to write, though.
- mjw1007 7y agoIt might. On the other hand, I think if the authors of software concentrated on 2 and 4, they could hope for third parties to help with 1 and 3. Doing things the other way round seems much more difficult.