Documentation

Good software documentation is important. Learn how to write better docs.

Good API Documentation

by Lukas Atkinson

This post provides suggestions on writing good API documentation that targets programmers: how you can document a class, library, or command line utility so that other programmers or power users can make good use of it. Not covered is documentation for end users or GUIs, although some ideas would certainly translate.

read full post (12 min)