Documentation Patterns
Use this skill when the main problem is document shape and consistency rather than writing quality alone.
Activation Conditions
- Creating a new API, feature, or config guide
- Standardizing Markdown sections across repositories
- Writing migration or runbook documents
- Picking the right template for a doc request
Pattern Selection
- API docs: endpoints, auth, request and response schema, errors
- Feature docs: purpose, UX, dependencies, rollout, support
- Config docs: env vars, defaults, examples, failure modes
- Migration docs: changed behavior, upgrade path, verification
References & Resources
Documentation
- API Documentation Templates - Endpoint, SDK, and function documentation patterns
- Feature Documentation Templates - Feature overview, rollout, and troubleshooting patterns
- Configuration Documentation Templates - Config and environment variable templates
Scripts
- Doc Template Picker - Print a starter Markdown template for
api,feature,config, ormigration
Related Skills
| Skill | Relationship |
|---|---|
| documentation-authoring | Use patterns when creating new documents |
| documentation-quality | Quality standards that patterns should follow |
| breaking-changes-management | Templates for migration guides and changelogs |