Menu
Analyze the pedagogical UX of a documentation outline: progression from beginner to advanced, signposting, and reading flow.
Install with Codex or Claude Copy this prompt, paste it into Codex, Claude, or another assistant, and let it review the skill page and install it for you.
Based on SOC occupation classification
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.
Generate an outline for a new documentation page from a topic brief and the appropriate template.
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.
| name | outline-ux-analyzer |
| description | Analyze the pedagogical UX of a documentation outline: progression from beginner to advanced, signposting, and reading flow. |
| argument-hint | [--no-log] <file path> |
| user-invocable | true |
$ARGUMENTS is a relative path to a documentation page.
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:review), write into that run's existing directory instead of creating a new one.
Read ../../references/prompts/outline-ux-analyzer.md and use it as the system prompt over the target.
Target: <path>
UX score: <1-5>
Findings:
- <section/heading>: <UX issue>: <suggestion>