Use when: "document", "docs", "README", "API docs", "OpenAPI", "Swagger", "Diátaxis", "tutorial", "how-to", "reference", "explanation", "SDK", "developer docs", "knowledge OS", "7-pattern stack".
View on GitHubboshu2/agentops
domain-kit
January 24, 2026
Select agents to install to:
npx add-skill https://github.com/boshu2/agentops/blob/main/plugins/domain-kit/skills/documentation/SKILL.md -a claude-code --skill documentationInstallation paths:
.claude/skills/documentation/# Documentation Skill Documentation creation, optimization, and API documentation patterns. ## Quick Reference | Area | Key Patterns | When to Use | |------|--------------|-------------| | **Create** | 7-pattern stack, Diátaxis | New documentation | | **Optimize** | Knowledge OS standards | Refactoring docs | | **Audit** | Diátaxis compliance | Quality checks | | **API** | OpenAPI, SDKs, examples | Developer docs | --- ## Diátaxis Framework Documentation organized by user need: | Type | Purpose | User Need | |------|---------|-----------| | **Tutorial** | Learning-oriented | "Teach me" | | **How-to** | Task-oriented | "Help me do X" | | **Reference** | Information-oriented | "Tell me about X" | | **Explanation** | Understanding-oriented | "Explain why" | ### Placement Rules ``` docs/ ├── tutorials/ # Learning journeys (ordered steps) ├── how-to/ # Task guides (problem → solution) ├── reference/ # Technical specs (accurate, complete) └── explanation/ # Concepts (why things work) ``` ### Content Types **Tutorial** (teaches): - Ordered steps for beginners - "Build your first X" - Focus on learning, not speed **How-to** (guides): - Problem-focused - "How to configure X for Y" - Assumes basic knowledge **Reference** (describes): - Complete, accurate specs - API documentation - Configuration options **Explanation** (explains): - Conceptual understanding - Architecture decisions - Trade-offs and alternatives --- ## 7-Pattern Documentation Stack | Pattern | Purpose | Location | |---------|---------|----------| | **README** | Entry point | Root | | **CLAUDE.md** | AI context | Root | | **Tutorials** | Learning | docs/tutorials/ | | **How-to** | Tasks | docs/how-to/ | | **Reference** | Specs | docs/reference/ | | **Explanation** | Concepts | docs/explanation/ | | **ADRs** | Decisions | docs/decisions/ | --- ## Documentation Creation ### Approach 1. Identify documentation type (Diátaxis) 2. Match content to user need 3. Use consistent struc