OpenParable
Skip to content
← Back to skills

Outline

Business
outline

Outline is an Agent Skill for business published in the strapi/documentation repository on GitHub: a SKILL.md instruction file an AI agent can load to do this task.

Generate an outline for a new documentation page from a topic brief and the appropriate template.

View on GitHub ↗
QUICK START

How to use this skill

Bring this guide into your coding agent with a prompt tailored to the tool you use.

  1. Open your project in Codex.
  2. Copy and paste the prompt below.
  3. Review files and risks before approving any action.
Prompt to paste
Inspect the Agent Skill at https://github.com/strapi/documentation/blob/HEAD/claude-plugins/inki/skills/outline/SKILL.md and all supporting files. Report provenance, permissions, scripts, dependencies, and security risks. Propose an exact installation into .agents/skills/outline, but wait for my approval before writing files or running scripts.

Copying this prompt does not install or run the skill. Review third-party files before use.

/inki:outline: generate a page outline

Step 0: Parse arguments

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.

Step 1: Read the brief

The remaining $ARGUMENTS is either inline text or a path to a .md file containing the brief.

Step 2: Pick the template

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.

Step 3: Apply the migrated outliner prompts

Read ../../references/prompts/outliner.md and ../../references/prompts/outline-generator.md. Use them as system prompts to produce an outline.

Step 4: Show the outline for approval

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).

Step 5: Save

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.