documentlisted

Generate or sync API / contract / user-facing documentation from the live system. Use when the user says '/document', 'document this endpoint', 'document the API', 'sync the contract docs', 'capture the new pages', 'write the user guide', 'export the SDK', 'auto-generate', 'generate the wiki for X', or 'refresh the docs'.
Maximumsoft-Co-LTD/claude-flightdeck · ★ 2 · Data & Documents · score 78

Install: claude install-skill Maximumsoft-Co-LTD/claude-flightdeck

# /document — Generate / Sync Project Documentation Generate user-facing or contract-facing documentation from the source of truth (live system, OpenAPI / proto / GraphQL schema, in-repo design docs, or screenshots from a real browser). The skill picks the right source for the request and loads the matching variant reference. ## Token budget (MANDATORY) - Use Grep to discover existing docs before regenerating — don't rewrite what's already there. - Read the live spec / contract / schema as the canonical source. - For UI screenshots, drive a real browser (Playwright MCP) — never trust a curl response for SPA pages. ## Usage - `/document` — full sync (regenerates everything in scope) - `/document <module>` — sync one module / endpoint group / feature - `/document status` — show coverage (documented vs existing) - `/document refresh` — re-capture + update existing pages - `/document export` — emit deployable artifact (SQL seed / static site / SDK package) ## Prerequisites check Before any generation step, verify: 1. The source-of-truth is reachable (live service / spec file / repo). 2. If screenshots are part of the output: the frontend + backend are running, and Playwright MCP is available. 3. Output directory exists and is writable. If any prerequisite fails → tell the user what's missing and stop. ## Steps ### 1. Discover scope `Glob` existing docs; `Grep` the source of truth; compute the diff (what's documented vs what exists). Read `docs/.manifest.json`