Documentation Strategy

Planning documentation so engineers can find what they need.

Context

You are planning documentation for a project or team. Multiple levels serve different needs.

Domain Context

• README: First thing people read; quick start
• Architecture: How system is organized; key decisions
• API Docs: How to use services; generated from schema
• Runbooks: How to respond to alerts; specific procedures
• ADR: Why we chose this tech/approach; decisions recorded
• HOWTO: Step-by-step guides; "how do I deploy?"

Instructions