Hacker News new | ask | show | jobs
by afarrell 2052 days ago
The best forms of documentation are, in order:

1. Encapsulating complexity to eliminate the need.

2. Well-designed UI Affordances to eliminate the need.

3. Documentation presented just in time at the Point of Action

4. A concisely illustrated mental model explanation and some specific searchable how-tos.

5. Well-written answers on StackOverflow.

For more on this, see the Django community and Write the Docs.