Thu 24 Oct 2019

How to Write Good Documentation

Documentation is one of the most important and under-rated aspects of any library or open-source project. If you are writing code that will be used by someone other than yourself, it needs to be documented. Period.

After using many libraries (both open-source and private), and writing a few of my own, I noticed that all good documentation can be broken down into a bunch of distinct elements.

Source: How to Write Good Documentation (And Its Essential Elements), an article by Soham Kamani.

Everything curl - the book

Everything curl is an extensive, detailed and totally free book, available in multiple formats.

Learn how to use curl. How to use libcurl. How to build them from source or perhaps how the curl project accepts contributions. There's something for everyone in this, from the casual first-time users to the experienced libcurl hackers.

Everything curl is written by Daniel Stenberg but is also itself an open project that accepts your contributions and help.

Cover of Everything curl
Cover of Everything curl by Daniel Stenberg.

Source: Everything curl. This is great news, and of course I downloaded the free book.