Skip to content
Get packs

Technical Documentation Builder

Writes and audits repo docs, README files, and AGENTS.md/CONTRIBUTING.md instruction files

Source Download skill
Repository
openclaw/clawhub
Stars
9,546
Licence
MIT
Files
12 files

What it does

Once installed, the agent follows a structured playbook for creating or reviewing technical documentation in a code repository. It inventories the docs and governance files (AGENTS.md, CONTRIBUTING.md, alias files like CLAUDE.md or .cursorrules, plus docs folders and READMEs), checks them for drift, broken commands and policy conflicts, and can fix high-confidence defects in the same pass unless told to report only. For large repos it can delegate discovery and review to sub-agents and merge their findings into one prioritized fix plan.

Great for

  • Maintainers who want their README, docs folder and AGENTS.md or CONTRIBUTING.md kept accurate and consistent
  • Teams with several agent instruction files (CLAUDE.md, .cursorrules, AGENTS.md) that need one canonical source
  • Anyone preparing an onboarding or contributor guide for an existing open-source project

Skip it if

  • Simple one-off text edits, where the playbook adds unnecessary process
  • Repos where the agent is allowed to edit files without review, since it may apply fixes directly by default and this can introduce unwanted changes
  • Projects without a docs framework or governance files, where much of the workflow has nothing to act on

Try asking

  • “Review the docs and README changes in this pull request for structure and accuracy”
  • “Audit the whole repo for documentation drift and list the issues in report-only mode”
  • “Update AGENTS.md and CONTRIBUTING.md so they agree with our current PR workflow”
  • “Write an evergreen getting-started guide for this library”
Step-by-step guide: how to use Technical Documentation BuilderInstall, first run, examples, tips and FAQs

Install in 3 steps

  1. 1

    Download the skill

    The ZIP contains the 12 original files, the MIT licence and an attribution note.

    technical-documentation.zip
  2. 2

    Add it to your agent

    Claude Code (all projects)

    mkdir -p ~/.claude/skills && unzip technical-documentation.zip -d ~/.claude/skills/

    Claude Code / Agent SDK (this project only)

    mkdir -p .claude/skills && unzip technical-documentation.zip -d .claude/skills/

    Claude apps (web/desktop): Settings → Capabilities → Skills → Upload skill, and choose the ZIP.

  3. 3

    Ask for the task

    No special command needed — the agent reads the skill's description and loads it when your request matches. Try one of the prompts above.

Get better results

  • Ask for report-only mode first to see the findings before letting the agent apply fixes
  • Name the doc type (tutorial, how-to, reference, explanation) and audience so the output matches your needs
  • Point the agent at AGENTS.md as the canonical file when your repo also has alias instruction files

What's inside

  • agents/docs-framework-agent.md
  • agents/governance-agent.md
  • agents/inventory-agent.md
  • agents/openai.yaml
  • agents/synthesis-agent.md
  • references/agent-and-contributing.md
  • references/build.md
  • references/openclaw.md
  • references/principles.md
  • references/review.md
  • references/tooling.md
  • SKILL.md

Redistributed unmodified from openclaw/clawhub under the MIT licence. The assessment was drafted with AI from the skill's files on 2026-10-29. Skills can instruct your agent to run code — read SKILL.md and any scripts before installing.