Skip to content

Write a technical manual

Writes a long, version-pinned technical manual backed by offline captures and a source audit

Stars
76,331
Licence
MIT
Files
7 files

What it does

When installed, the agent follows a detailed method for writing a long reference manual about one technical subject at one exact version, such as a protocol or file format. It pins the version, ranks sources, records the subject's real requests and responses from an offline capture, writes each section in a fixed shape, and runs an audit that must report zero findings. Think of it as a documentation workflow rather than a single writing prompt.

Great for

  • Engineers documenting a protocol, specification, or runtime they need others to maintain
  • Technical writers building a versioned reference with examples taken from real captured output
  • Teams in a repository that already has the manuals tooling, such as the worked example manuals/a2a-101

Skip it if

  • Short how-to guides or general concept lessons: the skill says a manual under about 15 sections does not need this shape, and general concepts should be lessons instead
  • Subjects that have no fixed version or change weekly, because the method depends on pinning a commit
  • Projects that cannot run the subject offline: without captures the skill itself says the result is an essay

Try asking

  • “Write a 101 manual for the Model Context Protocol at a pinned spec version”
  • “Add a manual section on CancelTask and terminal states to the existing manual”
  • “Build a capture kit for this server and record its requests and responses offline”
  • “Audit the manual and fix every finding until the audit prints TOTAL 0”
Step-by-step guide: how to use Write a technical manualInstall, first run, examples, tips and FAQs

Install in 3 steps

  1. 1

    Download the skill

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

    write-manual.zip
  2. 2

    Add it to your agent

    Claude Code (all projects)

    mkdir -p ~/.claude/skills && unzip write-manual.zip -d ~/.claude/skills/

    Claude Code / Agent SDK (this project only)

    mkdir -p .claude/skills && unzip write-manual.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

  • Pin the subject version and commit first, because every later claim and listing depends on it
  • Cut every code listing from a real capture file rather than writing examples from memory
  • Read the referenced audit and capture-kit files before running the workflow so you know what the scripts will do

What's inside

  • references/audit.md
  • references/capture-kit.md
  • references/manual-json.md
  • references/prose-rules.md
  • references/research-and-sources.md
  • references/section-template.md
  • SKILL.md

Redistributed unmodified from rohitg00/ai-engineering-from-scratch 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.