- name
SKILL.md
技能文件保留在发布者的仓库中。
在终端中粘贴复制的命令。它会把这个 SKILL.md 安装到对应的智能体中。
npx skills add phuryn/product-engineering --skill document-app -a cursor -y在终端中粘贴复制的命令。它会把这个 SKILL.md 安装到对应的智能体中。
npx skills add phuryn/product-engineering --skill document-app -a claude-code -y在终端中粘贴复制的命令。它会把这个 SKILL.md 安装到对应的智能体中。
npx skills add phuryn/product-engineering --skill document-app -a codex -y在终端中粘贴复制的命令。它会把这个 SKILL.md 安装到对应的智能体中。
npx skills add phuryn/product-engineering --skill document-app -a grok -y在 Grok Bot 聊天中发送复制的消息。Bot 会从 GitHub 获取这个 SKILL.md,并添加到你所有 Bot 共享的技能中。
Install this skill: https://github.com/phuryn/product-engineering/tree/HEAD/ai-shipping/skills/document-app来自发布者
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.
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
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.
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, give parallel subagents one core document each. Each reads the code slice its doc describes; reconcile the cross-references yourself.
Always produce the core documents. They cover:
architecture.md — system overview, stack, auth flow, trust boundaries.flows.md — the permission-relevant journeys: each protected step's authz check, the trust-boundary crossings, and the side effects each flow causes.permissions.md — roles, scope derivation, resource × operation × role matrix, RLS vs. code-enforced checks.variables.md — config & secrets mapped to risk and rotation.Produce a conditional document only when its capability exists. Otherwise, note its absence in one line rather than inventing content.
emails.md — notification path, templates, retry/backoff, failure visibility.cron.md — scheduled-work inventory, idempotency, internal-call auth.seo.md — SPA preview approach, route coverage, metadata sanitization.automation.md — embedded agents/automations: trigger, tool surface, steering vs. hard guardrails, output contract, app-owned side effects, approval gates.Describe the current state honestly, without being paranoid. Skip conditional documents that do not apply and say so. Add a "Related Documents" reference in architecture.md for each doc produced. The test-coverage map, tests.md, is produced separately by the derive-tests skill.
Report every document's path, what was skipped, and what remains unclear. Say what was created or updated and whether each path follows the repo's setup or a plugin default. Explain each skip and any gaps where the code was too unclear to document confidently; those are the first things to fix.
Offer the next steps after reporting the documentation work. Use these options:
derive-tests skill) so each documented rule has a verification plan?"/ai-shipping:ship-check, or $ai-shipping:ship-check in Codex) to wire agent context and produce a full shipping packet?"Check-only mode reports disagreements and writes no file. This lets a release check hand-maintained intent against code without overwriting it. Write no doc, report, or draft of a missing doc.
intended-vs-implemented skill's discipline: cite both the claim and its code path. Report every factual disagreement, not only the ones that cross a boundary; skip wording and style.Print the output in the conversation:
Doc check: [scope] — check-only, no files written
### Disagreements
1. [topic]
- Doc says: [claim] — `[doc path]:[line]`
- Code does: [behavior] — `[code path]:[line]`
- Owner decides: fix the code or fix the doc.
### In the code, in no doc
- [behavior] — `[code path]:[line]` (would belong in [doc])
### Not checked
- [absent docs, claims too vague to verify, code out of scope]
### Summary
Doc check, [date], commit [short SHA], scope [scope]: [N] docs read, [N] disagreements, [N] undocumented behaviors, [N] not checked. No files written. Which side to fix is the owner's call.
State what was read when the Disagreements section is empty. Then stop: don't offer to rewrite the docs.
AGENTS.md or CLAUDE.md, whichever the repo's structure makes canonical. It contains instructions derived from these docs.Every core doc exists or is listed as absent with the reason. Each claim points to its code, and the report names unclear-code gaps; in check mode, nothing on disk changed.
'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.
---name: document-appdescription: 'Document the app': write or refresh an app's system docs from its code. 'Are the docs right?': check mode…---# ai-shipping/skills/document-app/SKILL.md常见问题
从发布者处下载 ai-shipping/skills/document-app/SKILL.md,或复制路径后打开仓库。PlugMCP 只收录该技能,不托管文件。
发布者将它存放在 https://github.com/phuryn/product-engineering。
Claude、Cursor、Codex 和 Grok Build 可以读取你从发布者仓库添加的 SKILL.md。在聊天中发送技能的 GitHub 文件夹链接,Grok Bot 就会安装它。