Documentation Standards Skill
Knowledge base for documentation architecture, standards, and AI-ready documentation practices.
Overview
This skill provides comprehensive knowledge about documentation frameworks, standards, and best practices for creating documentation that serves both humans and AI systems.
Contents
| File | Purpose |
|------|---------|
| diataxis.md | Di?taxis framework reference (4 doc types) |
| adr-template.md | Architecture Decision Record template and lifecycle |
| doc-config-template.yml | Repository documentation configuration |
| doc-map-template.yml | Code-to-documentation bidirectional mapping |
| context-packaging.md | AI context optimization and token budgeting |
When to Use
- New project: Set up documentation structure from scratch
- Audit: Check existing docs against Di?taxis principles
- ADR: Create architectural decision records
- AI context: Prepare documentation for LLM consumption
- Sync: Configure doc-map for change tracking
Quick Start
1. Copy templates to your project:
``
docs/_meta/doc-config.yml ? from doc-config-template.yml
docs/_meta/doc-map.yml ? from doc-map-template.yml
`
2. Create Di?taxis structure:
`
docs/
??? index.md
??? tutorials/
??? how-to/
??? reference/
??? explanation/
??? adr/
??? ops/
`
3. Run /docs:doctor to check health
Key Concepts
Di?taxis Framework
| Type | Orientation | User Need |
|------|-------------|-----------|
| Tutorials | Learning | "Teach me" |
| How-to | Tasks | "Help me do X" |
| Reference | Information | "What is X?" |
| Explanation | Understanding | "Why X?" |
Documentation Mapping
`yaml
doc-map.yml connects code to docs
modules:
auth:
code_paths: ["src/Auth/"]
docs:
reference: "reference/auth.md"
how-to: ["how-to/configure-oauth.md"]
`
AI Context Principles
1. Minimum viable context - Less is more
2. Freshness - No stale docs
3. Relevance - Filter by scope
4. No duplication - Single source of truth
Related Components
Agents:
- documentation-architect
- Strategy and structure
- documentation-engineer
- Execution and sync
Commands:
- docs-sync
- Synchronize docs with code
- docs-doctor
- Health check
Procedures:
- PROC-01` - Documentation Maintenance (weekly)
