plan-doc

Generates structured plan documents under .claude/plans and registers them in a per-project INDEX.md.

Updated Apr 8, 2017
One-click install
npx skills add https://github.com/localmin/dotfiles --skill plan-doc-localmin
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: plan-doc
Source: https://github.com/localmin/dotfiles/tree/main/coding-agents/skills/plan-doc
Command: npx skills add https://github.com/localmin/dotfiles --skill plan-doc-localmin

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) components.

What problem does it solve? Decisions and requirements agreed during plan mode disappear when a session ends or context compaction runs. This Skill persists those discussions as structured Markdown documents inside the project so they can be re-referenced across sessions. ## Core Features & Use Cases - Structured plan generation: Creates a dated plan document from a template with sections for Goals, Spec, assumptions and verification status, design, task breakdown, implementation approach, and testing. - Automatic indexing: Registers each new plan in a per-project .claude/plans/INDEX.md so resuming work starts from a single index file. - Slug sanitization and idempotency: The script sanitizes slugs, skips existing documents, and avoids duplicate INDEX entries. - Use Case: After settling requirements and design trade-offs in plan mode, persist the outcome as 2025-01-15-auth-redesign.md under the project's .claude/plans/ directory, then resume the work days later by reading the INDEX entry. ## Quick Start Ask the AI to save the current plan-mode discussion as a persistent plan document by running the new-plan script with a short slug for the topic.

Frequently Asked Questions about plan-doc

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I save a plan mode discussion as a persistent document?

Run the new-plan.sh script with a slug, for example `bash scripts/new-plan.sh auth-redesign`. It creates a dated Markdown file under .claude/plans from the template and adds a reference line to INDEX.md, which you then fill in with the discussion content.

Where are plan documents stored in a project?

Plan documents are stored under the project root in `.claude/plans/`, named with the date and slug like `2025-01-15-auth-redesign.md`. An INDEX.md file in the same directory lists all plans for quick lookup when resuming work.

What sections does the plan document template include?

The template includes Goals, Spec, assumptions and verification status, design, task breakdown, implementation approach, and testing sections. Assumptions must be marked verified or unverified, and permanent decisions should be extracted into ADRs under docs/adr/.

What happens if I run new-plan.sh with the same slug twice?

The script is idempotent. If the dated document already exists it prints a skip message instead of overwriting, and if the INDEX already contains the entry it skips adding a duplicate line.

Does new-plan.sh require a specific project root argument?

No, the project root argument is optional. Without it, the script uses the git top-level directory from `git rev-parse --show-toplevel`, falling back to the current working directory if not inside a git repository.