Description
Documentation is an agent skill for writing and maintaining technical documentation for different audiences and purposes. It covers two main document types. A README explains what the project is and why it exists, gives a quick start that reaches first success in under five minutes, describes configuration and usage, and includes a contributing guide. API documentation lists endpoints with request and response examples, explains authentication and error codes, sets out rate limits and pagination, and includes SDK examples. The skill is useful when a project has no docs, when existing docs have fallen out of date, or when new team members need an onboarding guide. You can trigger it with phrases such as write docs for, document this, create a README, write a runbook or onboarding guide. It is part of Anthropic's knowledge-work plugins.…
Highlights
- Writes README files with quick start and configuration sections
- Writes API documentation with endpoints, auth and error codes
- Covers rate limits, pagination and SDK examples
- Triggers on phrases such as document this and create a README
Ratings & Reviews
No ratings yet
Be the first to rate documentation.
People also visit
codebase-onboarding
Analyze an unfamiliar codebase and generate a structured onboarding guide
understand-onboard
Generate an onboarding guide for new team members joining a project
code-documentation
The user requests to generate, create, or improve documentation for code, APIs
documentation FAQ
What document types does it write?
README files and API documentation, plus runbooks and onboarding guides when you ask for them.
What goes in a README?
What the project is, a quick start that reaches first success in under five minutes, configuration and usage, and a contributing guide.
What goes in API docs?
Endpoint reference with request and response examples, authentication, error codes, rate limits, pagination and SDK examples.
Who is it for?
Developers and technical writers who maintain project docs or need onboarding material.
How do I install it?
Run npx skills add https://github.com/anthropics/knowledge-work-plugins --skill documentation in your terminal.
Is it free?
Yes. The skill is listed as free on skills.sh.
What security audits has it passed?
skills.sh lists three audits: Gen Agent Trust Hub Pass, Socket Pass and Snyk Pass.
What are the best documentation alternatives?
Popular alternatives to documentation include code-tour, codebase-onboarding and ecc-guide. See all documentation alternatives