Having worked in the software industry for oh, forever, I’ve worked with a lot of software developers. And there is a universal truth in the realm of software development: Programmers hate to write documentation. Even those developers who begin a project with the best of intentions end of stumbling somewhere along the way, and the code that is ultimately produced contains little or no useful documentation. But ironically, software developers LOVE good API documentation.
Well, of course they do. Good API documentation leads a programmer by the hand through the jungle of functions, methods, events, parameters and yes, the dreaded best practices. The best API documentation should include the following elements:
- Completeness. Every aspect of an API should be documented.
- Examples. This is very important.
- Sample applications, if available.
- Ease of use and accessibility. API Documentation is best presented in an online format with lots of related links, easily accessible to the busy, impatient programmer.
- Coverage of multiple languages, if applicable and practical.
- Documentation of error codes.
CohenWrite has a lot of experience working with software developers and API documentation. Let us help you help your developers.