SuperAPI AI Directory

create-plan

Coding & development

View repository

Updated 10-31 09:23

About this skill

create-plan

Turn what is known about a task into one plan file that a person can review line by line. The plan lives in the task directory, and comments are written into the file, so the review history stays with the plan and survives a new session.

The layout (path, file name, front matter, comment block, the "done" signal) is fixed in references/artifact-layout.md. Only scripts/artifact.mjs writes the front matter.

Steps

  1. Find the task directory. Ask for the task name if it was not given (kebab-case, one per branch, issue or lane). List what is already there:

    node "${CLAUDE_SKILL_DIR}/scripts/artifact.mjs" status --task-dir .ork/tasks/<task>
    
  1. Read every artifact in it in full, in NN order: research, earlier plans, and their comment blocks. Open comments on an earlier artifact are requirements unless they were resolved.

  2. Read the code the research points at. Every file the plan changes must be opened, so file paths and code in the plan are real.

  3. Write the body to a scratch file, using references/plan-template.md. Each phase is testable on its own, names the files it changes, and ends with runnable automated checks.

  4. Create the artifact through the script (never write the file directly):

    node "${CLAUDE_SKILL_DIR}/scripts/artifact.mjs" create \
      --task <task> --kind plan --slug <slug> --title "<title>" --author <your seat> --body /tmp/plan-body.md
    # prints .ork/tasks/<task>/NN-plan-<slug>.md
    
  5. Reply with the path and stop. Ask the reviewer to comment in the file (or run /ork:review-artifact-comments after they do). Do not start implementing.

Rules

  • When documents disagree, the newest wins: plan over research over the original ask.
  • Out of scope is a section, not an afterthought: list what the plan will not do.
  • Manual checks only where a person really has to look; do not pad phases with them.
  • A second plan for the same task is a new artifact (new NN), not an edit of the old one. Revising the same plan is iterate-plan.

Related

  • /ork:iterate-plan: revise this plan from review comments, keeping every comment.
  • /ork:create-research: the research artifact this plan should read first.
  • /ork:review-artifact-comments: read, answer and resolve comments on any artifact.