Technical Documentation

Purpose

Write documentation that answers the question the reader actually has. Most documentation fails because it mixes four incompatible purposes into one document and serves none of them.

When to Use

• Writing a README, a getting-started guide, or API reference.
• Documentation that exists but that nobody can use.
• Documenting a library, a service, or an internal system.
• Auditing documentation for gaps.

Capabilities