mcpField
P
planning-documentation

planning-documentation

github.com/qodex-aiエージェントワークフロー47147 回インストール42 週間前に更新
リポジトリ

planning-documentation について

コードベースに不慣れな開発者向けに、実装計画を小さくテスト可能な作業へ分解するスキルです。ファイルパスやコマンドを明記し、TDD、こまめなコミット、実行ワークフローへの引き継ぎを重視します。

主な機能

  1. 01計画を2~5分の操作に分割
  2. 02ファイル、コード、テストコマンドを明記
  3. 03テストの期待結果を記載
  4. 04TDDとこまめなコミット
  5. 05実行への引き継ぎ方法を提示

活用シーン

  1. 01不慣れなコードベースの機能計画
  2. 02実装をテスト可能な手順に分割
  3. 03別の実行セッション向けの計画準備

インストール

コマンドをコピーしてターミナルで実行します。

$npx skills add https://github.com/qodex-ai/ai-agent-skills --skill planning-documentation

インストール後、Claude Code で/planning-documentationを入力して読み込まれたか確認します。

詳細

計画の作成

概要

エンジニアが私たちのコードベースについてまったく文脈を持っておらず、センスも疑わしいと仮定して、包括的な実装計画を作成します。エンジニアが知っておくべきことすべてを文書化します。各タスクで触るべきファイル、コード、テスト、確認すべきドキュメント、テスト方法などです。計画全体を細かいタスクとして渡します。DRY。YAGNI。TDD。頻繁なコミット。

エンジニアは熟練した開発者である一方、私たちのツールセットや問題領域についてはほとんど何も知らないと仮定します。また、良いテスト設計についてよく理解していないと仮定します。

開始時に宣言: 「実装計画を作成するために writing-plans スキルを使用しています。」

コンテキスト: これは専用のワークツリーで実行する必要があります(brainstorming スキルによって作成されます)。

計画の保存先: docs/plans/YYYY-MM-DD-<feature-name>.md

細かいタスクの粒度

各ステップは1つのアクションです(2〜5分):

  • 「失敗するテストを書く」 - ステップ
  • 「実行して失敗することを確認する」 - ステップ
  • 「テストに合格するための最小限のコードを実装する」 - ステップ
  • 「テストを実行して合格することを確認する」 - ステップ
  • 「コミットする」 - ステップ

計画ドキュメントのヘッダー

すべての計画はこのヘッダーで始まる必要があります:

# [Feature Name] Implementation Plan

> **For Claude:** REQUIRED SUB-SKILL: Use superpowers:executing-plans to implement this plan task-by-task.

**Goal:** [One sentence describing what this builds]

**Architecture:** [2-3 sentences about approach]

**Tech Stack:** [Key technologies/libraries]

---

タスク構造

### Task N: [Component Name]

**Files:**
- Create: `exact/path/to/file.py`
- Modify: `exact/path/to/existing.py:123-145`
- Test: `tests/exact/path/to/test.py`

**Step 1: Write the failing test**

```python
def test_specific_behavior():
    result = function(input)
    assert result == expected

ステップ2: テストを実行して失敗することを確認する

実行: pytest tests/path/test.py::test_name -v 期待される結果: FAIL with "function not defined"

ステップ3: 最小限の実装を書く

def function(input):
    return expected

ステップ4: テストを実行して合格することを確認する

実行: pytest tests/path/test.py::test_name -v 期待される結果: PASS

ステップ5: コミットする

git add tests/path/test.py src/path/file.py
git commit -m "feat: add specific feature"

## Remember
- Exact file paths always
- Complete code in plan (not "add validation")
- Exact commands with expected output
- Reference relevant skills with @ syntax
- DRY, YAGNI, TDD, frequent commits

## Execution Handoff

After saving the plan, offer execution choice:

**"Plan complete and saved to `docs/plans/<filename>.md`. Two execution options:**

**1. Subagent-Driven (this session)** - I dispatch fresh subagent per task, review between tasks, fast iteration

**2. Parallel Session (separate)** - Open new session with executing-plans, batch execution with checkpoints

**Which approach?"**

**If Subagent-Driven chosen:**
- **REQUIRED SUB-SKILL:** Use superpowers:subagent-driven-development
- Stay in this session
- Fresh subagent per task + code review

**If Parallel Session chosen:**
- Guide them to open new session in worktree
- **REQUIRED SUB-SKILL:** New session uses superpowers:executing-plans

コメント