القائمة
Run the docflow readiness gate before reporting docs complete: checks links, INDEX freshness, metadata, placeholders, and changelog names. Use after writing or editing docs.
التثبيت باستخدام 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".
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".
| name | validate |
| description | Run the docflow readiness gate before reporting docs complete: checks links, INDEX freshness, metadata, placeholders, and changelog names. Use after writing or editing docs. |
Goal: block objectively broken documentation before an agent reports work as complete.
bash scripts/docflow-validate.sh --target <REPO ROOT>
If running from an installed plugin where scripts are not in the target repo, use the plugin script path.
Errors are blockers. Fix them before saying the docs are complete.Warnings are legacy/adoption cleanup. Report them, but they do not block unless the user asked for a strict cleanup./docflow:author, /docflow:changelog, /docflow:repair, or any manual docs edit.INDEX.md before validation when files were added, renamed, or removed.