← ClaudeAtlas

ce-ship-documentlisted

Generate user-facing documentation — README, getting-started/usage guide, API/interface reference, configuration — grounded in the plan's VERIFIED behavior, every example run not narrated. Never writes the versioned CHANGELOG.md (that is /core-engineering:ce-ship-release's). Triggers: write or regenerate user-facing docs, a README, or API/usage reference. To VALIDATE that a reader can follow an existing doc (not write one), use /core-engineering:ce-doc-audit.
relusion/vg-sdlc-claude-plugins · ★ 0 · Code & Development · score 70
Install: claude install-skill relusion/vg-sdlc-claude-plugins
# Ship Document **Invocation input:** Plan to document (and optional --audience / --target): $ARGUMENTS Write the documentation a *user* of this software reads — grounded in what the plan actually built and verified. `/core-engineering:ce-ship-document` turns the pipeline's proven output into durable, user-facing product documentation: a README, a getting-started / usage guide, an API or interface reference, and configuration docs. It writes these into the project's **real** doc locations (`README.md`, `docs/`, …) — not the planning tree — and it documents **only verified behavior**, with **runnable** examples. It runs after the work is verified: ``` plan → spec → implement → verify → document ``` Distinct from what already produces text: - **vs the planning tree (`docs/plans/**`)** — those are *process* artifacts (plans, specs, decisions) for the team. `/core-engineering:ce-ship-document` writes *product* docs for the user, into the repo's own doc paths. - **vs `/core-engineering:ce-implement`'s Try-It runbook** — the runbook is per-feature, local exploration-for-confidence, *not* verification; `/core-engineering:ce-ship-document` is the durable, audience-shaped product manual whose examples are freshly run and verification-backed. - **vs `/core-engineering:ce-ship-release`** — release owns the versioned `CHANGELOG.md`; `/core-engineering:ce-ship-document` never writes it (it may render or link it read-only, or write a distinctly-named usage doc such as `