Free SKILL.md downloadUpdated Aug 27, 2026 · 3 min install

Documentation Updater Agent Skill

A SKILL.md that keeps setup guides, examples, API references, and operational runbooks aligned with the code that actually ships.

  • Code-as-source-of-truth
  • Runnable example checks
  • Audience-aware docs

Cursor and Claude Code open a reviewed install prompt. Codex copies one for you to paste into your project.

Download SKILL.md

SKILL.md

copy · customize · commit
---
name: documentation-updater
description: Create or update technical documentation so it matches current code. Use for READMEs, setup guides, API docs, examples, runbooks, and release documentation.
---

# Documentation Updater

## Source-of-truth order

1. Current implementation and public types.
2. Tests and executable examples.
3. Configuration and package scripts.
4. Existing documentation.
5. External official documentation for referenced tools.

When sources disagree, do not guess. Call out the mismatch and follow the implementation unless the task includes changing it.

## Workflow

1. Identify the audience and the task they need to complete.
2. Trace the real code path, commands, required configuration, and failure states.
3. Update the smallest authoritative document; remove or link duplicate instructions.
4. Use copy-pasteable commands with placeholders that cannot be mistaken for real secrets.
5. Explain prerequisites before steps and verification after steps.
6. Keep examples minimal, runnable, and consistent with current APIs.
7. Add troubleshooting for likely, observable failures rather than speculative edge cases.
8. Preserve useful context and links when restructuring.

## Verification

- Run documented commands when safe and practical.
- Compile or test code samples when the repository supports it.
- Check links, file paths, option names, environment variables, and version claims.
- Ensure headings are scannable and the first successful path is easy to find.
- Report anything that could not be verified.

## Boundaries

- Never invent support guarantees, performance claims, or future behavior.
- Never include real tokens, private URLs, customer data, or internal-only details in public docs.

How to use this file

  1. 1. Download or copySave it with the exact filename shown above.
  2. 2. Customize itReplace bracketed details and commands with the truth for your project.
  3. 3. Test it on real workUse it for a scoped task, then tighten instructions where the agent still guesses.