AutoGineer
Generated banner for Documentation
Generated logo for Documentation

Documentation

AnthropicOfficialPublished by Anthropic

  • Skill
  • Content generator
  • Documents and content
  • Apache-2.0
  • No issues found
Download ZIP

From the author

Write and maintain technical documentation. Trigger with "write docs for", "document this", "create a README", "write a runbook", "onboarding guide", or when the user needs help with any form of technical writing — API docs, architecture docs, or operational runbooks.
— the description by Anthropic

AutoGineer summary

Written by AutoGineer from the skill’s own files, not by the author

This skill assists in the creation and maintenance of technical documentation tailored to specific needs and audiences. It provides structured templates and best practices for common technical documents, ensuring that information is presented clearly and remains useful for developers, operators, and stakeholders.

What it does

  • Generates README files with quick start guides and contribution instructions
  • Creates API documentation including endpoints, authentication, and error codes
  • Drafts operational runbooks with step-by-step procedures and escalation paths
  • Produces architecture documentation covering design decisions and data flows
  • Develops onboarding guides for environment setup and system navigation
  • Applies technical writing principles to ensure clarity and relevance

When to use it

  • When you need to create a new project README
  • When documenting API endpoints for developers
  • When preparing operational runbooks for incident response
  • When outlining system architecture and design trade-offs
  • When creating onboarding materials for new team members

Advantages

  • Provides standardized structures for diverse technical document types
  • Focuses on reader-centric content delivery
  • Emphasizes the use of code examples and practical demonstrations
  • Promotes maintainability by encouraging linking over duplication

Usage examples

“write docs for my new API”
The agent generates an API reference document including endpoint definitions, request/response examples, and authentication details.
“create a README for this project”
The agent produces a README template containing a project description, quick start guide, configuration steps, and a contribution section.
“write a runbook for database migration”
The agent creates a structured runbook detailing prerequisites, the migration procedure, rollback steps, and escalation contacts.
“onboarding guide for new developers”
The agent drafts a guide covering environment setup, key system overviews, and common task walkthroughs.

Install

  1. Download the skill as a ZIP:

    https://autogineer.com/agent-skills/anthropics/documentation/download

  2. Unzip it into the cross-client skills folder of your project:

    mkdir -p .agents/skills && unzip documentation.zip -d .agents/skills

Documentation by Anthropic

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

  1. Write for the reader — Who is reading this and what do they need?

  2. Start with the most useful information — Don't bury the lede

  3. Show, don't tell — Code examples, commands, screenshots

  4. Keep it current — Outdated docs are worse than no docs

  5. Link, don't duplicate — Reference other docs instead of copying

Files

Requirements and compatibility

Written for: Claude Code, Claude apps

Works with: Claude Code, Claude apps, OpenAI Codex, GitHub Copilot, Cursor, Gemini CLI, Kiro, OpenCode, Goose, Amp, Roo Code, JetBrains Junie, Factory Droid, Devin (ex-Windsurf), Mistral Vibe, OpenHands, Letta

“Works with” means the tool reads the open Agent Skills format; a skill written for one tool may use features others lack.

Security

No issues found by our static scan· No issues found

A static scan is not a guarantee. Skills are third-party content: review a skill before you let an agent use it.

Attribution and licence

Published by
Anthropic
Publisher
Anthropic (Official)
Source
anthropics/knowledge-work-plugins · engineering/skills/documentation · commit e050c2e
Licence
Apache License 2.0 (redistribution allowed)
  • LICENSE (added by AutoGineer from LICENSE)
  • ATTRIBUTION.md (written by AutoGineer)
Synced

AutoGineer is not affiliated with or endorsed by Anthropic or Anthropic.

Download ZIP

The ZIP holds the skill’s files, its licence files and an ATTRIBUTION.md. Download documentation.zip