القائمة
Generate an outline for a new documentation page from a topic brief and the appropriate template.
التثبيت باستخدام Codex أو Claude انسخ هذا Prompt والصقه في Codex أو Claude أو مساعد آخر ليراجع صفحة Skill ويثبّتها لك.
استنادا إلى تصنيف SOC المهني
Top-level review orchestrator: runs style-check, outline-check, outline-ux-analyzer, code-verify, coherence-check, and pitfalls-check on a file, directory, or PR.
Create a pull request on strapi/documentation following git-rules.md. Strict flat-text description, no headings, no test plan.
End-to-end documentation orchestrator: chains all four inki phases (research, write, review, submit) for a single subject. Gates between each phase by default; --non-interactive chains without pauses and runs a review-fix loop. The simplest way to document a subject from scratch.
Add a new entry to the known-pitfalls catalog that pitfalls-check audits against. Verifies the correct pattern against the Strapi source before adding, and confirms with the user. Use when you have found a documentation mistake worth catching automatically in future reviews.
Rewrite the title or description/body of one or more open PRs on strapi/documentation to match git-rules.md. Strict one-by-one confirmation, or auto-edit with --non-interactive.
Top-level orchestrator: branch (if needed), commit, push, then open a PR. Each step asks for confirmation before continuing, unless --non-interactive is passed.
| name | outline |
| description | Generate an outline for a new documentation page from a topic brief and the appropriate template. |
| argument-hint | [--non-interactive] [--no-log] <topic brief or path to a brief file> |
| user-invocable | true |
If $ARGUMENTS contains --help or -h, print usage and stop, per ../../references/help.md. Do not run the skill.
Otherwise, from $ARGUMENTS, detect the autonomy flag anywhere in the list: --non-interactive (canonical), aliases --auto-approve, --auto, --yes, -y, --no-questions-asked (all equivalent). If present, set AUTO=true and remove the flag. What remains is the brief.
Logging: unless --no-log is passed, write this skill's report to the run log per ../../references/logging.md (--log-dir <path> and --short-log are also accepted). When invoked as part of an orchestrator (e.g. /inki:write), write into that run's existing directory instead of creating a new one.
The remaining $ARGUMENTS is either inline text or a path to a .md file containing the brief.
Decide which template applies (feature, plugin, guide, API, configuration, breaking-change) based on the brief. Read the relevant template at ../../references/templates/<template>-template.md.
Read ../../references/prompts/outliner.md and ../../references/prompts/outline-generator.md. Use them as system prompts to produce an outline.
If AUTO=true, skip the approval gate and go straight to Step 5, saving to the default path.
Otherwise, display the outline. Wait for y (accept) / n (discard) / e (edit inline).
On y (or in AUTO=true mode), save the outline as a .md file. In interactive mode, confirm the path with the user (typically under docusaurus/docs/<area>/<slug>.outline.md); in auto mode, use that default path without prompting.
