All commands

Command

/shipmates-document

draft from the code → fresh-reader test → fix drift

Write docs from the code, then make a new reader complete them.

See it run

Illustrative terminal recording of the stages /shipmates-document runs, in order.
Illustrative — the stages /shipmates-document runs, in order.

How to run it

Run it in your harness

/shipmates-document <what to document — a module, a feature, a public API, the README, the whole repo>

<angle brackets> = required · [square brackets] = optional

How it works

  1. Audience

    Who is this for, and what kind of doc is it — tutorial, how-to, reference, or explanation?

    No specialist — you pick audience and type.

  2. Draft

    The writer works from the real signatures, flags, and outputs — not from memory.

  3. Test

    A fresh agent that did not draft the doc follows the steps against the repo and must reach the stated result.

    A fresh agent — not the writer, and not a named specialist.

  4. Fix

    The writer repairs whatever the reader could not complete. Loop until they can finish without help.

When to use

  • User-facing docs drifted from what the repo actually does.
  • Agent-facing map of the repo? /shipmates-onboard.

The skill

The installer ships the full skill — stages, gates, config — from commands/shipmates-document.md.

Read the skill on GitHub