Skill Tracer
Skills › Knowledge Work Plugins › documentation

documentation

skill · 49 lines · Apache-2.0 · engineering/skills/documentation/SKILL.md

The facts

Its description

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 the agent reads to decide when to use it.

From its settingsline 3

When it starts

A person asks for help writing or refreshing technical documentation — a README, API reference, runbook, architecture doc, or onboarding guide — or simply says to document something. The description is broad enough that any technical-writing request in an engineering context would pull it in.

Things a person might say (the model's guesses)

  • “Write a README for this repo”
  • “Can you document this service's API endpoints?”
  • “Write a runbook for restarting the payments worker”

A model's summary of when it is used.

A model's reading

Licence

Apache-2.0, from LICENSE

The terms its author shares it under, which let it be shown here.

From the repositorylicence text

The text

Open on GitHub
1---
2name: documentation
3description: 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.
4---
5
6# Technical Documentation
7
8Write clear, maintainable technical documentation for different audiences and purposes.
9

Technical Documentation

Write clear, maintainable technical documentation for different audiences and purposes.

Raw lines 1 to 9
10## Document Types

Document Types

Raw lines 10 to 11
12### README
13- What this is and why it exists
14- Quick start (< 5 minutes to first success)
15- Configuration and usage
16- Contributing guide

README

  • What this is and why it exists
  • Quick start (< 5 minutes to first success)
  • Configuration and usage
  • Contributing guide
Raw lines 12 to 17
18### API Documentation
19- Endpoint reference with request/response examples
20- Authentication and error codes
21- Rate limits and pagination
22- SDK examples

API Documentation

  • Endpoint reference with request/response examples
  • Authentication and error codes
  • Rate limits and pagination
  • SDK examples
Raw lines 18 to 23
24### Runbook
25- When to use this runbook
26- Prerequisites and access needed
27- Step-by-step procedure
28- Rollback steps
29- Escalation path

Runbook

  • When to use this runbook
  • Prerequisites and access needed
  • Step-by-step procedure
  • Rollback steps
  • Escalation path
Raw lines 24 to 30
31### Architecture Doc
32- Context and goals
33- High-level design with diagrams
34- Key decisions and trade-offs
35- Data flow and integration points

Architecture Doc

  • Context and goals
  • High-level design with diagrams
  • Key decisions and trade-offs
  • Data flow and integration points
Raw lines 31 to 36
37### Onboarding Guide
38- Environment setup
39- Key systems and how they connect
40- Common tasks with walkthroughs
41- Who to ask for what

Onboarding Guide

  • Environment setup
  • Key systems and how they connect
  • Common tasks with walkthroughs
  • Who to ask for what
Raw lines 37 to 42
43## Principles
451. **Write for the reader** — Who is reading this and what do they need?
462. **Start with the most useful information** — Don't bury the lede
473. **Show, don't tell** — Code examples, commands, screenshots
484. **Keep it current** — Outdated docs are worse than no docs
495. **Link, don't duplicate** — Reference other docs instead of copying

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
Raw lines 43 to 49

From anthropics/knowledge-work-plugins at 2574e29, 2026-10-27. Skills read by DeepSeek V4.1 Flash on 2026-11-04. Summary and techniques by Claude Opus 5.5 on 2026-11-06.