plan-author

Generate a PR-scoped plan document and update the plan index.

18|Updated Feb 14, 2020

Search Tags:#scoping #markdown #pull request #docs #plan #index

Ready to run

npx skills add https://github.com/subroh0508/colormaster --skill plan-author-subroh0508

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: plan-author
Source: https://github.com/subroh0508/colormaster/tree/main/.claude/skills/plan-author
Command: npx skills add https://github.com/subroh0508/colormaster --skill plan-author-subroh0508

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

単一の PR で完結する取り組みについて、Plan を手作業で新規作成し、インデックスも更新する負担を減らします。

Core Features & Use Cases

Plan 生成: docs/plans/PLAN-NNN-*.md を 1 ファイル作成し、所定のテンプレートに沿って記述します。
INDEX 更新: docs/plans/INDEX.md に追記して、Plan の一覧性を保ちます。
適用場面: feature-request、bug-fix、refactor のうち、1 PR で完了できる規模の作業を整理したいときに使います。

Quick Start

単一 PR スコープの依頼内容を渡して、対応する Plan ファイルの作成と docs/plans/INDEX.md の更新を進めてください。

Frequently Asked Questions about plan-author

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

FAQPage Schema

How do I generate a PR-scoped plan document for a single pull request?▼

To generate a PR-scoped plan document, provide your feature request, bug fix, or refactor details. The tool creates a single markdown plan file in docs/plans/ using the required template and Japanese headings.

What is the Epic-versus-Plan threshold for scoping markdown documentation?▼

The Epic-versus-Plan threshold distinguishes large initiatives from single PR tasks. Plans apply only to work small enough to finish in one pull request, ensuring the generated markdown remains focused and manageable.

How do I keep the plan index synchronized when adding new markdown docs?▼

To keep the plan index synchronized, the tool automatically appends new entries to docs/plans/INDEX.md. This preserves catalog visibility whenever a new PR-scoped markdown plan is generated.

Does this work for refactoring and bug fixes or only feature requests?▼

This works for refactoring, bug fixes, and feature requests. It applies to any single PR-scoped task, generating the required frontmatter and markdown structure for each specific type of update.

When should I avoid using a single pull request plan?▼

You should avoid using a single pull request plan when the work exceeds the Epic-versus-Plan threshold. If the feature, bug fix, or refactor requires multiple PRs, it is too large for this scoping approach.