Technical Documentation

Good technical documentation reduces onboarding time, prevents repeated questions, and makes systems maintainable by people who didn't build them.

When to Activate

• Writing a README for a new project or service
• Documenting an API with OpenAPI/Swagger
• Writing a runbook for an on-call engineer
• Creating an onboarding guide for a team
• Documenting a significant technical decision (ADR)
• Setting up documentation-as-code with auto-deploy to GitHub Pages

README Structure

A README is the front door to your project — it answers "what is this and how do I use it?" in under 5 minutes.

# service-name