document-app

Featured

'Document the app': write or refresh an app's system docs from its code. 'Are the docs right?': check mode, which only reports where docs and code disagree.

Data & Documents 633 stars 85 forks Updated today MIT

Install

View on GitHub

Quality Score: 94/100

Stars 20%
93
Recency 20%
100
Frontmatter 20%
70
Documentation 15%
100
Issue Health 10%
80
License 10%
100
Description 5%
100

Skill Content

# Document the app -- Make the System Reviewable **Document the system honestly so people and agents can review it.** Produce the durable documentation an AI-built app is missing. Map what the system is, who can do what, and where the risk lives. These docs are the foundation every later audit compares the code against. ## Invocation **Use check-only mode when asked only to check the docs.** A request that starts with `check` also selects that mode, on the scope that follows it. ``` /ai-shipping:document-app Claude Code /ai-shipping:document-app supabase/functions $ai-shipping:document-app the backend Codex /ai-shipping:document-app check "document this app" · "check our docs against the code" either agent, in plain words ``` ## Workflow ### Step 1: Scope **Document the requested scope, or the whole repository when none is given.** If the request starts with `check`, skip to Check-only mode with the rest as the scope. For the whole repository, prioritize backend code, auth, data access, background jobs, and anything that sends, schedules, or exposes data. ### Step 2: Reverse-Engineer the Docs **Read the code as the source of truth for system docs.** Apply the `shipping-artifacts` skill and produce the applicable documents. Follow its Locations and names rule: use the repo's own docs location and existing equivalents first. Use the names below, in `documentation/` at the repo root, only where the repo has none. **For large scopes, ...

Details

Author
phuryn
Repository
phuryn/product-engineering
Created
2 weeks ago
Last Updated
today
Language
Python
License
MIT

Integrates with

Similar Skills

Semantically similar based on skill content — not just same category