菜单
Set up docflow in a repo with no docs yet: scaffold the docs tree, write docflow.json, add agent guidance. Use when asked to "set up docflow", "initialize docs", "scaffold docs", or "make this repo use docflow".
用 Codex 或 Claude 帮你安装 复制这段 Prompt，粘贴到 Codex、Claude 或其他助手里，让它检查 Skill 页面并帮你完成安装。
基于 SOC 职业分类
Add docflow to a repo that already has docs, without rewriting them. Adds missing config, folders, helpers, agent guidance, and an adoption review. Use when docs already exist or doctor recommends adopt.
Write a new doc in the right place with the right name. Use when asked to "write a doc", "where should this doc go", "add an ADR", "document this decision", "new spec", or "new feature plan".
Record shipped work in the monthly changelog (append-only). Use when something ships or when asked "what changed", "add to changelog", "release notes", or "what shipped this month".
Friendly docflow readiness check: one status, one reason, and the exact next command. Use when asked if docflow is set up, ready, or "what do I do next".
Read-only docflow diagnosis: scans docs, config, changelog, and links, then recommends init, adopt, or repair. Use when asked "check docs setup", "should I set up docflow", "why is docflow not working", or "doctor".
Safe maintenance for an existing docflow setup: regenerate INDEX.md, install missing helpers, check links, report placeholders. Use after adding/renaming docs or when doctor recommends repair.
| name | init |
| description | Set up docflow in a repo with no docs yet: scaffold the docs tree, write docflow.json, add agent guidance. Use when asked to "set up docflow", "initialize docs", "scaffold docs", or "make this repo use docflow". |
Goal: initialize docflow only when doctor says this repo has no meaningful docs yet. Keep existing user-authored files; generated maintenance files may be refreshed.
bash scripts/docflow-doctor.sh --target <REPO ROOT>
Route by recommendation.
docflow-init: continue.docflow-adopt: stop and run /docflow:adopt instead (preserves existing docs).docflow-repair: stop and run /docflow:repair instead.Pick docs root.
docs/ unless the user explicitly chooses another root.Pick project name.
README.md has clear project title, use that.Run scaffold from plugin root (idempotent; skips existing user content, refreshes generated files):
bash scripts/scaffold.sh --docs-root <DOCS_ROOT> --project "<PROJECT NAME>" --target "<REPO ROOT>"
This creates the category tree, drops templates, writes docflow.json, and scaffolds AGENTS.md + GEMINI.md + .cursorrules.
Add root README link if missing:
## Documentation<DOCS_ROOT>/README.mdSeed the first changelog. Create <DOCS_ROOT>/changelog/(mmm-yy).md for the current month from the template, summarizing recent history (git log --no-merges --pretty='%h %ad %s' --date=short -20). Use the changelog skill for the format.
Regenerate the map and validate:
bash scripts/docflow-map.sh "<REPO ROOT>/<DOCS_ROOT>"
bash scripts/docflow-validate.sh --target "<REPO ROOT>"
Fresh template placeholders are warnings; validation errors are blockers.
Report what was created (docs root, docflow.json, AGENTS.md, GEMINI.md, .cursorrules, validation status) and point the user at /docflow:author (writing), /docflow:router (reading), /docflow:validate (readiness), /docflow:repair (maintenance).
/docflow:adopt over /docflow:init.AGENTS.md and docflow.json aligned on docs root.<DOCS_ROOT>/NAMING.md for every file you create after.