documentation
Installation
SKILL.md
Documentation
Methodology for writing, auditing, and maintaining project documentation. Docs exist to orient developers quickly and accurately — stale docs are worse than no docs because they create false confidence.
Scope boundary: This skill covers human-written docs (
docs/,README.md). For generated artifacts (OpenAPI, TS client, schema files) → check the project's generated-code rule. For Claude config files (rules, skills, CLAUDE.md, memory) →/claude-authoring.
1. Documentation types
Each doc type has a distinct audience and update cadence:
| Type | Audience | Purpose | Update trigger |
|---|---|---|---|
| README.md | New developers, GitHub visitors | First impression, setup, quick orientation | Setup steps change, new prerequisites, project scope changes |
| Architecture | All developers | System structure, request flow, tech stack | New services, new layers, structural changes |
| API reference | Frontend developers, integrators | Endpoints, params, responses, errors | Any endpoint or validation change |
| Domain/entities | All developers | Business objects, invariants, relationships | Schema changes, new entities, rule changes |
| Auth | All developers, security reviewers | Auth flow, session management, config | Auth implementation changes |
| Database | Backend developers | Schema, migrations, CQRS, replication | Migration changes, new tables/columns |
| Testing | All developers | Test layers, commands, isolation, fixtures | New test infrastructure, new test patterns |
Related skills