documentation
npx machina-cli add skill anthropics/knowledge-work-plugins/documentation --openclawFiles (1)
SKILL.md
1.5 KB
Technical Documentation
Write clear, maintainable technical documentation for different audiences and purposes.
Document Types
README
- What this is and why it exists
- Quick start (< 5 minutes to first success)
- Configuration and usage
- Contributing guide
API Documentation
- Endpoint reference with request/response examples
- Authentication and error codes
- Rate limits and pagination
- SDK examples
Runbook
- When to use this runbook
- Prerequisites and access needed
- Step-by-step procedure
- Rollback steps
- Escalation path
Architecture Doc
- Context and goals
- High-level design with diagrams
- Key decisions and trade-offs
- Data flow and integration points
Onboarding Guide
- Environment setup
- Key systems and how they connect
- Common tasks with walkthroughs
- Who to ask for what
Principles
- Write for the reader — Who is reading this and what do they need?
- Start with the most useful information — Don't bury the lede
- Show, don't tell — Code examples, commands, screenshots
- Keep it current — Outdated docs are worse than no docs
- Link, don't duplicate — Reference other docs instead of copying
Source
git clone https://github.com/anthropics/knowledge-work-plugins/blob/main/engineering/skills/documentation/SKILL.mdView on GitHub Overview
This skill helps you write and maintain technical documentation across key types: README, API Documentation, Runbook, Architecture Doc, and Onboarding Guide. It emphasizes audience focus, concise structure, practical examples, and keeping docs current.
How This Skill Works
Provide the document type and target audience; I generate a structured doc with appropriate sections (readme, API references, runbook steps, architecture context, or onboarding tasks), include examples and diagrams where useful, and ensure cross-links and current information.
When to Use It
- You’re starting a new project and need a README with quick start, configuration, usage, and contribution guidance.
- Documenting an API: you need endpoint references, auth, errors, and pagination, plus SDK examples.
- Creating a runbook to standardize incident response or routine operations.
- Preparing an architecture doc with goals, high-level design, trade-offs, and data flow.
- Onboarding new engineers with environment setup, key systems, and walkthroughs.
Quick Start
- Step 1: Identify document type (README, API, Runbook, Architecture, Onboarding).
- Step 2: Outline sections tailored to the audience and purpose.
- Step 3: Draft with concrete examples, diagrams, and cross-links; review for currency.
Best Practices
- Write for the reader: define the audience and their needs.
- Start with the most useful information to avoid burying the lede.
- Show, don't tell: include code blocks, commands, or screenshots.
- Keep it current: regularly update and link to preferred sources.
- Link, don’t duplicate: reference related docs instead of duplicating content.
Example Use Cases
- README for a new open-source project with quick start and contribution guide.
- API documentation including endpoint references, auth, and sample requests/responses.
- Runbook outlining prerequisites, step-by-step procedures, rollback, and escalation.
- Architecture doc detailing goals, high-level design, data flow, and trade-offs.
- Onboarding guide covering environment setup and common tasks for new engineers.
Frequently Asked Questions
Add this skill to your agents
