documentlisted
Install: claude install-skill saman-mb/shipmates
# /document — draft from the code → fresh-reader test → fix drift
Produce docs that get a reader to *done*, gated on the one check that catches bad docs: a **fresh agent
with no prior context follows the instructions against the real repo and must reach the stated result**.
Docs that drift from the code or can't be completed are rejected and fixed. The gate is "a newcomer can
actually follow this," not "it reads well."
Input (**$ARGUMENTS**): what to document — a module, a feature, a public API/CLI, the README/getting-started,
a migration guide, or the whole repo. If empty, ask what to document and for whom.
---
## Config
- `WRITER` = `technical-writer`. `READER` = a **fresh** `general-purpose` (or `technical-writer`) agent that
has NOT seen the drafting — it only gets the doc + the repo, like a real newcomer.
- `MAX_ROUNDS` = `3` — the fresh-reader fix loop cap (Stage 3). `MODE` = `pr` (default) — a worktree,
a branch and a CI-gated PR, reusing `/ship-issue`'s isolate stage and its commit-push-PR stage;
your checkout is left exactly as you left it. `edit-in-place` writes the docs straight into the
working tree — still available, but ask for it.
- Under `MODE=pr`: `BASE_BRANCH` = the repo's default branch — the PR's target, not what the
worktree is cut from (that's current `HEAD`, so the draft has your latest work in it).
`WORKTREE_DIR` = `../<repo>--docs-<slug>`. `BRANCH` = `docs/<slug>`.
`MERGE_MODE` = `manual` (stop at a reviewed PR; `auto` opt-in). `MAX