mcpField
D
developer-summary

developer-summary

github.com/validkeysドキュメント166 回インストール19 週間前に更新
リポジトリ

developer-summary について

Sherpyの計画成果物から、開発者向けの要約を作成するスキルです。プロジェクトの範囲、成果物、マイルストーン、日程をまとめ、入力不足があれば明示します。

主な機能

  1. 01標準の計画ファイルを検出
  2. 02不足している成果物を確認
  3. 03プロジェクトと成果物を要約
  4. 04マイルストーンと日程を整理
  5. 05Markdown形式で要約を出力

活用シーン

  1. 01Sherpy計画から開発者向け引き継ぎを作成
  2. 02プロジェクトの節目と見積もりを確認
  3. 03利用可能なファイルから部分要約を生成

インストール

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

$npx skills add https://github.com/validkeys/sherpy --skill developer-summary

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

同梱ファイルreferences/example.mdreferences/output-spec.md

詳細

開発者向けサマリー

Sherpy の計画成果物から、開発者向けのサマリー文書を生成します。開発者が、構築する内容、主な成果物、マイルストーンのロードマップをすばやく把握できるようにします。

使用方法

/developer-summary [base-directory]

ディレクトリが指定されていない場合は、現在のディレクトリに requirements/business-requirements.yaml があるかどうかを調べ、自動的に検出します。

見つからない場合は、ユーザーに「計画成果物はどこにありますか?」と尋ねます。

続行する前に、ユーザーがパスを指定するまで待ちます。

必須の成果物

このスキルは、標準の Sherpy フォルダー構成から以下のファイルを自動検出します。

ファイル場所用途
business-requirements.yamlrequirements/プロジェクトの概要と成果物
technical-requirements.yamlrequirements/技術的な背景とアーキテクチャ
milestones.yamlimplementation/マイルストーンの順序と見積もり
timeline.yamldelivery/スケジュールの見積もりと日付

手順

ステップ 1: 基本ディレクトリを特定し、必須の成果物を検索する

ディレクトリのパラメーターが指定されていない場合は、現在のディレクトリに requirements/business-requirements.yaml があるかどうかを確認します。

  • 見つかった場合は、現在のディレクトリを base_directory として使用します
  • 見つからない場合は、「計画成果物はどこにありますか?」と尋ね、ユーザーの回答を待ちます

base_directory が特定されたら、標準の場所で必須ファイルを検索します。ステータスを表示します。

## Developer Summary — Dependency Check

Scanning for required artifacts...

 ✓  requirements/business-requirements.yaml
 ✓  requirements/technical-requirements.yaml
 ✓  implementation/milestones.yaml
 ✗  delivery/timeline.yaml

3 of 4 required files found.

凡例: ✓ 見つかりました · ✗ 見つかりません

ステップ 2: 見つからないファイルに対応する

必須ファイルが見つからない場合は、次のように尋ねます。

"必須ファイルが見つかりません:timeline.yaml

選択肢:

  1. 部分的なデータで続行 — 入手可能な情報を使ってサマリーを生成します(不足するセクションには [Not Available] と表示されます)
  2. 終了 — 不足している成果物を先に完成させます(/delivery-timeline を実行して timeline.yaml を生成します)

どちらにしますか?"

ユーザーの回答を待ちます。

  • ユーザーが 1(続行) を選んだ場合:入手可能なデータを使って処理を続け、不足するセクションを明確に示します
  • ユーザーが 2(終了) を選んだ場合:実行するスキルを表示し、正常に終了します
ステップ 3: 成果物を読み込み、解析する

入手可能なすべてのファイルを読み込み、以下を抽出します。

business-requirements.yaml から:

  • プロジェクト名と説明
  • 主な機能と能力
  • 主な成果物

technical-requirements.yaml から:

  • 技術スタック
  • アーキテクチャパターン
  • 主な技術コンポーネント

milestones.yaml から:

  • マイルストーンの順序(m0、m1、m2 など)
  • マイルストーンの名称と説明
  • マイルストーン間の依存関係
  • マイルストーンごとの所要期間の見積もり

timeline.yaml から(利用可能な場合):

  • プロジェクト全体の所要期間
  • 目標完了日
  • 逆算した作業スケジュール
ステップ 4: 開発者向けサマリーを生成する

summary/developer-summary.md を作成します。

出力文書には、ヘッダー(タイムスタンプ、プロジェクト名)、Overview(3~5 文の要約)、Deliverables(カテゴリ別に分類)、Milestones & Timeline(所要期間、依存関係、主な成果物を含む M0、M1...)、Summary(マイルストーンの総数、所要期間の見積もり、目標完了日)が含まれます。

セクション構成と書式ルールを含む文書の完全な仕様については、references/output-spec.md を参照してください。

完全な例については、references/example.md を参照してください。

ステップ 5: 不足データに適切に対応する

必須ファイルが見つからない場合は、明確なプレースホルダーを挿入します。

## Milestones & Timeline

[Not Available - `milestones.yaml` not found. Run `/implementation-planner` to generate milestones.]

または、部分的なデータの場合:

## Summary

**Total Milestones:** 4
**Estimated Total Duration:** 6 weeks (estimated from milestones)
**Target Completion:** [Not Available - run `/delivery-timeline` to set production deploy date]
ステップ 6: 確認

サマリーを生成した後、次の内容を表示します。

## Developer Summary Generated ✓

**Location:** summaries/developer-summary.md
**Size:** [file size]

Summary includes:
  ✓ Project overview
  ✓ Deliverables breakdown
  ✓ Milestone roadmap
  [Missing data: timeline completion date - run /delivery-timeline]

The summary is ready for developer onboarding and reference.

成果物の抽出ロジック

成果物の特定

以下のソースを解析し、成果物のリストを作成します。

business-requirements.yaml から:

  • functional_requirements → ユーザー向け機能
  • features または capabilities → 高レベルの機能
  • scope.in_scope → 明示的に含まれる項目

technical-requirements.yaml から:

  • architecture.components → 技術コンポーネント
  • technology_stack → インフラ項目(データベース、API、サービス)
  • data_model.entities → ドメインエンティティ/モデル
  • apis.endpoints → 記載されている場合は API エンドポイント
  • integration_points → 外部連携
分類ルール

種類に基づいて、成果物を論理的なカテゴリに分類します。

  • API エンドポイント - REST/GraphQL エンドポイント、Webhook
  • ドメインハンドラー - ビジネスロジックハンドラー、コマンドプロセッサー
  • UI コンポーネント - ページ、ビュー、コンポーネント(該当する場合)
  • データモデル - エンティティ、スキーマ、データベーステーブル
  • インフラストラクチャ - データベース、メッセージキュー、認証システム
  • 連携 - 外部サービスとの接続
  • バックグラウンドジョブ - スケジュールされたタスク、ワーカー
  • 設定 - 環境設定、デプロイ設定

要件に含まれる内容に基づき、最も関連性の高いカテゴリを使用します。該当しないカテゴリを無理に含めないでください。

概要の生成ロジック

概要文の作成

複数のソースから情報をまとめ、簡潔でわかりやすい概要を作成します。

含める要素(順番どおり):

  1. 概要 - 構築するシステム/機能(1 文)
  2. 目的 - 解決する問題、または提供する価値(1 文)
  3. 方法(高レベル) - アプローチまたは主要な機能(任意、1 文)

使用するソースフィールド:

  • business-requirements.yaml:
    • description または overview
    • business_goals.primary_goal
    • success_criteria
  • technical-requirements.yaml:
    • solution_overview
    • architecture.approach

テンプレート:

「[システム名] は、[主要な機能] を行う [システムの種類] です。[問題] に対し、[解決アプローチ] によって取り組み、[主な利点/成果] を実現します。このシステムでは、[主要な技術的アプローチまたは差別化要因] を採用します。」

例:

「Sherpy CLI は、AI を活用したソフトウェア開発のための構造化された計画ツールです。ガイド付きのインタビューを実施し、タスク単位の詳細を含む包括的な実装計画を生成することで、要件の乖離や計画の抜け漏れに対処します。計画プロセス全体を通じて、タスクの適切な規模設定、TDD 要件、スタイルアンカーなどのベストプラクティスを徹底します。」

簡潔にまとめる
  • 最大 5 文にします
  • 概要に箇条書きを使いません
  • 実装の詳細ではなく、ビジネス価値に焦点を当てます
  • ドメイン固有で必要な場合を除き、専門用語は避けます

マイルストーンロードマップのロジック

マイルストーン情報の抽出

milestones.yaml の各マイルストーンについて、以下を抽出します。

必須フィールド:

  • id - マイルストーン識別子(m0、m1 など)
  • name - マイルストーンのタイトル
  • description - マイルストーンで達成する内容
  • estimated_duration - 所要時間の見積もり
  • dependencies - 先に完了する必要があるマイルストーン

書式:

  • マイルストーンを順番に表示します(m0 → m1 → m2...)
  • 依存関係を明確に示します
  • 説明の最初の行、または最も重要な成功基準から「主要な成果物」を強調します

抽出例:

# From milestones.yaml:
milestones:
  - id: m1
    name: API Foundation
    description: |
      Build core REST API with authentication and authorization.
      Includes user management endpoints and JWT token handling.
    dependencies: [m0]
    estimated_duration: 2 weeks
    success_criteria:
      - All auth endpoints functional
      - JWT tokens properly validated

次のように表示されます:

### M1: API Foundation
**Duration:** 2 weeks
**Dependencies:** M0
**Key Deliverable:** Core REST API with authentication and authorization
タイムラインの計算

timeline.yaml がある場合:

  • total_duration フィールドを使用します
  • 目標完了日には production_deploy_date を使用します
  • 計算したプロジェクト日程を表示します

milestones.yaml のみがある場合:

  • すべての estimated_duration の値を合計します
  • 適切な単位(日/週)に換算します
  • これは QA/PR にかかる時間を含まない見積もりであることを明記します

どちらもない場合:

  • 「TBD」とし、適切なスキルを実行するよう案内します

エラー処理

ファイルが見つからない場合

必須ファイルが想定される場所に存在しない場合:

  • 代替となる一般的な場所を確認します(フォールバックとしてルートディレクトリを確認)
  • 試した正確なパスを示し、明確なエラーを表示します
  • そのファイルを生成する Sherpy スキルを提示します
無効な YAML

ファイルは存在していても、解析できない場合:

  • 解析エラーを表示します
  • 可能であれば、ファイルパスと行番号を表示します
  • ファイル形式を確認するか、ファイルを再生成するよう提案します
必須フィールドの欠落

ファイルに想定されるフィールドがない場合:

  • 適切なデフォルト値を使用するか、「[未指定]」と記載します
  • 利用可能なデータを使って概要の生成を続行します
  • 確認出力で不足しているフィールドを示します

出力先

常に次の場所に出力します:{base_directory}/summaries/developer-summary.md

ディレクトリが存在しない場合は作成します:

mkdir -p {base_directory}/summaries

Sherpy Flow との連携

このスキルは、/sherpy-flow の Step 10 として呼び出されるよう設計されています。sherpy-flow から呼び出された場合、base_directory をパラメーターとして受け取ります。次のように動作します:

  • すべての計画関連成果物が完成した後に実行します
  • base_directory 内の整理されたフォルダー構成からファイルを自動検出します
  • タイムラインなどの任意ファイルがなくても失敗しません
  • すべてのファイルがそろっている場合は、ユーザーの操作なしで概要を生成します

例

開発者向け概要の完全なサンプルについては、references/example.md を参照してください。

関連スキル

  • /executive-summary - ステークホルダー向けのエグゼクティブサマリーを生成します
  • /sherpy-flow - 計画ワークフロー全体(最後にこのスキルを含みます)
  • /implementation-planner - このスキルで使用する milestones.yaml を生成します
  • /delivery-timeline - このスキルで使用する timeline.yaml を生成します

コメント