Making world-class docs takes effort | daniel.haxx.se

See Making world-class docs takes effort | daniel.haxx.se on daniel.haxx.se

Technical writing and documentation are seriously undervalued yet their absence is hard to ignore. Here Daniel, creator of cURL outlines some principles for good documentation that he is working towards, namely it:

• must be in code repository,
• shouldn’t be generated from code,
• should include examples,
• needs to document all API calls,
• be easy to view (Divio documentation system is pretty good), and
• let others contribute