agentleFS
tykisgodtykisgod/quick-question/skills/plan/SKILL.md

plan

Skill12 starsChanged 8 months agoMITView on GitHub

Generate a technical implementation plan from a game design document or a brief description. Outputs architecture, interfaces, ordered steps with file paths.

184 other projects use a version of this.

Adopted by

Most recently taken up by

Used with

Projects with it also use heartmula, webhook-subscriptions and 10 more.

Other files people use alongside this one.

Files found in the same public projects as a version of this one, more often than they turn up anywhere else. Each project counts once, large collections count for less, and this file's own repository is left out.
  • math-incSkill

    heartmula

    Set up and run HeartMuLa, the open-source music generation model family (Suno-like). Generates full songs from lyrics + tags with multilingual support.

    Also in 9 projects that use this

  • Tommy-ywSkill

    webhook-subscriptions

    Create and manage webhook subscriptions for event-driven agent activation, or for direct push notifications (zero LLM cost). Use when the user wants external services to trigger agent runs OR push notifications to chats.

    Also in 5 projects that use this

  • math-incSkill

    minecraft-modpack-server

    Set up a modded Minecraft server from a CurseForge/Modrinth server pack zip. Covers NeoForge/Forge install, Java version, JVM tuning, firewall, LAN config, backups, and launch scripts.

    Also in 5 projects that use this

  • john-data-chenSkill

    touchdesigner-mcp

    Control a running TouchDesigner instance via twozero MCP — create operators, set parameters, wire connections, execute Python, build real-time visuals. 36 native tools.

    Also in 6 projects that use this

  • gaebalaiSkill

    codex-system

    PROACTIVELY consult Codex CLI, your highly capable supporter with exceptional reasoning and task completion abilities. Codex is a trusted expert you should ALWAYS consult BEFORE making decisions on: design choices, implementation approaches, debugging strategies, refactoring plans, or any non-trivial problem. When uncertain, consult Codex. Don't hesitate - Codex provides better analysis. Explicit triggers: "think deeper", "analyze", "second opinion", "consult codex".

    Also in 3 projects that use this

  • ibahgatSkill

    context-optimize

    Improve context efficiency and cache stability for long or complex sessions.

    Also in 3 projects that use this

  • +3 more from math-inc

The file

We split this skill into the rules it gives an agent

8 rules. 0 are common, 3 are distinctive, and 5 are very specific to this project.

  • 0

    Common

    Most of the 167 edited versions we read keep these.

  • 3

    Distinctive

    This author's own choices. Worth a look.

  • 5

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    No arguments: check conversation context for a recent design discussion

    line 18
  2. Very specific:

    Read AGENTS.md if it exists (architecture layers, module boundaries), the relevant code under Assets/Scripts/, and the .asmdef structure.

    line 28
  3. Very specific:

    Only when .claude/seams.yml exists.

    line 32
  4. Distinctive:

    Keep each step to 1-3 files.

    line 142
  5. Distinctive:

    Write actual interface signatures, not prose descriptions.

    line 145
  6. Very specific:

    Put - [ ] checkboxes only on steps: /qq:execute ticks them by step title, falling back to position, so a checkbox anywhere else can be …

    line 151
  7. Very specific:

    If the design doc is ambiguous, say so in Open Questions instead of guessing.

    line 153
  8. Very specific:

    --auto mode: run the Codex check first, then

    line 173

“Common” is measured: kept by at least 6 in 10 of the 167 edited versions of this file we could read. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

Run qq scripts as ${CLAUDE_PLUGIN_ROOT}/bin/<name>: they are not on PATH, so a bare qq-execute-checkpoint.py exits 127.

Respond in the user's preferred language (detect from their recent messages, or fall back to the language setting in CLAUDE.md).

Generate a technical implementation plan for Unity that /qq:execute can consume. It turns an existing design into engineering steps; it is not a game design document.

Workflow: take --workflow <name> from $ARGUMENTS if present, else run qq-config.py field workflow. On prototype-loop, write the slice list of shared/prototype-loop.md §Plan instead of the format in §3 and the requirements in "The plan must" (interface signatures, milestones, milestone coverage), and in §6 hand off as that section says (plan review only for hard-to-undo plans, otherwise straight to /qq:execute); on heavy-review (the default), follow this file as written.

Editor commands instead of code: a one-shot editor-state change (scene tweak, prefab override, UI adjustment, one-off data fix) can be a step marked "execute via Editor command X", named for the project's channel (shared/unity-live-state.md), e.g. unity-cli set_component_properties or tykit set-property. Official Unity CLI commands: shared/unity-cli-reference.md (look parameters up with unity command --project-path "$PWD" --query <keyword> --detail full --json); tykit: shared/tykit-reference.md. With no channel, or when the change needs version control, compile-time validation, or repeatable behavior, plan it as code or an asset change.

Arguments: $ARGUMENTS

  • A file path to a game design document
  • A brief description (1-2 sentences) of what to build
  • No arguments: check conversation context for a recent design discussion

1. Understand the Input

Design document (from Docs/qq/, Docs/design/, a Notion export, or inline): read it fully and extract the technical requirements.

One-liner ("add a health system"): explore the codebase first, then ask only what the code can't answer (which systems it touches, data format preference, hard constraints), at most 5 questions.

2. Explore the Codebase

Read AGENTS.md if it exists (architecture layers, module boundaries), the relevant code under Assets/Scripts/, and the .asmdef structure. Follow the project's existing patterns (event bus, service locator, dependency injection, …); introduce a new one only when the design requires it.

2.5. Cross-cutting Seams

Only when .claude/seams.yml exists. It lists the project's fan-out points: adding one thing (an enum value, interface implementation, event, registration, config row) needs matching edits elsewhere, and a missed one compiles clean but breaks or silently does nothing at runtime.

For each such addition in the plan, match it against the keys in .claude/seams.yml and copy the matched seam's sites[].grep commands into the plan's Cross-cutting Seams section (template below). Take seam points from seams.yml, not from memory. Append newly found seams to .claude/seams.yml, not just to this plan.

3. Write the Plan

One markdown document in this format, 1-3 pages.

# [Feature Name] — Implementation Plan

Design doc: <path> (or "none: from conversation")
User's request: copied verbatim from the design doc or the conversation

## Needs the user's decision
Copied from the design doc as is (omit if none). Undecided: build the normal rule, not these items.

## Goal
One sentence. What technical capability is added.

## Architecture
```mermaid
graph LR
    A[ComponentA] --> B[ComponentB]
    B --> C[ComponentC]

Key Types

TypeKindPurpose
FooMonoBehaviourDoes X
BarScriptableObjectStores Y
IFoointerfaceContract for X

Interfaces

public interface IFoo {
    void DoSomething(SomeEvent e);
    float Value { get; }
    event Action<float> OnValueChanged;
}

Data Schema

Any new config fields, serialized data, or save structures. Use actual field names and types.

Milestones

Milestone 1 is the thinnest slice where the user can run the game and see the core of the feature, even roughly. Every milestone ends in something the user can run and check.

MilestoneStepsChecklist itemsHow to try itWhat to look at
11-41, 3debug panel / test scene / cheat command1-5 things

Not in this plan: design items this plan does not build at all. Each needs the user's words agreeing to defer it; without them, put it in a milestone. Ordering work across this plan's milestones needs no one's agreement. If you group steps into phases, end each milestone at a phase boundary.

Steps

Ordered, each step is a shippable increment. Include:

  • Exact file paths (create or modify)
  • What to implement
  • Dependencies on previous steps
  • Done criteria (how to verify this step works)
  1. Create IFoo interface — Assets/Scripts/Systems/IFoo.cs
    • Define the contract shown above
    • No deps
    • Done: compiles
  2. Implement FooSystem — Assets/Scripts/Systems/FooSystem.cs
    • MonoBehaviour implementing IFoo
    • [SerializeField] private fields for config
    • Depends on: step 1
    • Done: compiles + can attach to GameObject
  3. Wire into existing BarSystem — Assets/Scripts/Systems/BarSystem.cs
    • Add IFoo dependency, call on trigger
    • Depends on: step 1, 2
    • Done: compiles + integration test passes
  4. Tests — Assets/Tests/EditMode/FooSystemTests.cs
    • Test damage calculation, edge cases (zero, negative, overflow)
    • Depends on: step 2
    • Done: /qq:add-tests can implement this coverage without ambiguity, then all tests green

Cross-cutting Seams

Only when .claude/seams.yml exists and the change adds an enum value, registration, event, or config row. One row per fan-out point it touches, seeded from seams.yml.

SeamLocate (grep)Needs change?How
Skills.GetLevel switchrg "case WorkType\." -- Assets/Scripts/yesadd a case per new WorkType; default still throws

Constraints

  • What NOT to do (anti-patterns to avoid)
  • Assembly definition placement
  • Execution order dependencies
  • Existing systems that must not break

Testing Strategy

  • EditMode: [what pure logic to test]
  • PlayMode: [what integration to test]

Open Questions

  • Anything unresolved that might change the plan

## The plan must

These hold for the `heavy-review` plan of §3. A `prototype-loop` slice list answers to [`shared/prototype-loop.md`](../../shared/prototype-loop.md) §Plan instead: no interface signatures or milestones, and every checklist item is covered by a slice or sits under "Not doing" with the user's words.

1. Give exact file paths (create or modify) for every step, not descriptions.
2. Keep each step to 1-3 files; split bigger ones.
3. Have a correct depends-on chain: no step uses something not yet created.
4. Compile after each step on its own.
5. Write actual interface signatures, not prose descriptions.
6. Contain no placeholders: no "TBD", "TODO", "implement later", or "similar to step N".
7. Make test steps concrete enough that `/qq:add-tests` can implement them without re-planning.
8. **Milestone 1 early:** Milestone 1 shows the core of the feature by the shortest path. For the rest it uses simple complete stand-ins (fixed numbers, a debug spawn, an existing system), each replaced by a named step in a later milestone. If it holds most of the steps, move work into later milestones, never into "Not in this plan".
9. **Coverage:** The plan delivers the quoted user's request, and every Acceptance Checklist item is covered by a milestone or listed under "Not in this plan".

Put `- [ ]` checkboxes only on steps: `/qq:execute` ticks them by step title, falling back to position, so a checkbox anywhere else can be ticked by mistake.

If the design doc is ambiguous, say so in Open Questions instead of guessing. For a non-trivial technical decision (a pathfinding algorithm, a state machine structure), invoke `/qq:tech-research` before committing to one in the plan.

## 4. Save the Plan

Save to `Docs/qq/<branch-name>/<feature-name>_implementation.md` (branch name from `git branch --show-current | tr '/' '_'`).

## 5. Record Decisions

Record the key technical decisions (architecture choices, patterns, key interfaces):
```bash
qq-decisions.py add --project . --phase plan --key "<decision>" --value "<choice>" --reason "<why>"

6. Handoff

Plan review comes before execution; don't offer /qq:execute directly. Check for Codex CLI with which codex 2>/dev/null || where codex 2>/dev/null:

  • Codex available → recommend /qq:codex-plan-review
  • Codex not available → recommend /qq:claude-plan-review

--auto mode: run the Codex check first, then qq-execute-checkpoint.py pipeline-advance --project . --completed-skill "/qq:plan" --next-skill "<the review skill chosen above>" --plan-doc "<saved-plan-path>" --design-doc "<design-doc-path, if the input was one>", then invoke that skill with --auto.

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.