mcpField
D
design-doc-reviewer

design-doc-reviewer

github.com/ehoテスト・品質148 回インストール9 週間前に更新
リポジトリ

design-doc-reviewer について

Design Doc Reviewerは、設計文書が妥当で簡潔な実装契約かを評価する読み取り専用スキルです。リポジトリの根拠を確認し、機械的検証を実行して、設計や状態を変更せずにバージョン付きレビューを保存します。

主な機能

  1. 01設計文書と共有契約を通読
  2. 02リポジトリの根拠に基づく記述確認
  3. 03リスクと実装境界の評価
  4. 04ストーリー契約の機械的検証
  5. 05ブロッカーと提案の区別
  6. 06バージョン付きレビューの保存

活用シーン

  1. 01実装前の設計レビュー
  2. 02設計の記述と既存コードの照合
  3. 03以前のブロッカーを基に改訂を確認
  4. 04設計状態を変えずにレビューを記録

インストール

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

$npx skills add https://github.com/eho/agent-skills --skill design-doc-reviewer

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

詳細

設計ドキュメントレビュー担当

設計が妥当で無駄のない実装契約かどうかを独立して判断します。読み取り専用で作業してください。レビュー成果物は保存しますが、設計を修正したり、そのステータスを変更したりしないでください。

対象ドキュメント全体と ../design-doc/references/design-contract.md を読んでください。執筆者向けプロンプトは読み込まないでください。共有契約がレビューの範囲です。

レビューの根拠を確認する

リポジトリの指示と、関連するビジョンまたはアーキテクチャのドキュメントを読んでください。重要な主張を支える、リスクの高いコード、テスト、スキーマ、設定、呼び出し箇所を独立して調査してください。レビューでは、次を区別してください。

  • リポジトリで現在確認できる事実
  • 提案されている設計上の決定
  • 未解決の前提

執筆者の調査をすべて再現するのではなく、リスクに見合った範囲を調査してください。正確そうなパスやシグネチャも、確認されるまでは証拠ではありません。

design-to-issues/scripts/story_contract.py の場所を特定して、次を実行してください。

python3 <story-contract-script> <design-doc> \
  --repo-root <repository-root> --mode author

機械的な検証の失敗はブロッキングです。このスクリプトが判定するのは構文と構造であり、意味上の品質ではありません。

レビューモード

初回レビュー

設計全体を読み、実装上の重要な境界をすべて調査してください。次を確認します。

  • 設計は、許可された範囲内で、明示されたプロダクト上の課題を解決していますか?
  • アーキテクチャ、責任範囲、状態・データの契約、統合動作、障害時の経路は、リポジトリおよび相互に整合していますか?
  • 該当する場合、セキュリティ、プライバシー、権限、移行、互換性、段階的な展開、ロールバック、パフォーマンス、運用は、実装に十分安全ですか?
  • リスクの高い動作を、循環的または利用できない証拠、あるいは事後的な証拠に頼らず検証できますか?
  • 正準ストーリーはそれぞれ、一貫した成果を記述し、その成果に影響する共通要件をすべて含み、有効な依存関係を使い、二値判定可能な基準と現実的な検証方法を示していますか?
  • 詳細に推測的なもの、重複しているもの、機能に対して不釣り合いなものはありませんか?不変条件を満たせるなら、簡素化するか既存の仕組みを優先してください。

懸念事項が、互換性のない、または安全でない実装、誤った動作、データ・セキュリティ・移行・互換性の失敗、達成不可能な基準、または対象範囲内のストーリーに必要な未解決の決定につながる可能性が十分にある場合に限り、ブロッキングとして扱ってください。仕上げの不足や機能強化の可能性は、ブロッキングではありません。

フォローアップレビュー

以前のレビューが提示された場合は、次を確認してください。

  1. 以前のブロッキング指摘のそれぞれ
  2. 変更されたセクションと、それが影響するすべてのストーリーまたは依存関係の範囲
  3. 機械的な検証
  4. 修正によって生じた重大なリグレッション

チェックリスト全体を作り直したり、対応不要とされた提案を再び取り上げたりしないでください。変更によって横断的なアーキテクチャ、セキュリティ境界、データ契約、移行、互換性、展開、またはストーリーの順序が変わり、限定的なレビューでは安全でない場合は、全面的なレビューに範囲を広げてください。

指摘事項

ブロッキング指摘には、すべて次を含めてください。

  • **根拠:**設計上の正確な箇所と、検証済みのリポジトリ上の証拠、または具体的な内部矛盾
  • **影響:**実装や提供がどのように失敗する可能性があるか
  • **必須の不変条件:**修正版が満たすべき条件

複数の解決策で不変条件を満たせる場合、新たなサブシステムを指定しないでください。例を挙げるのは、問題点の明確化に実質的に役立つ場合に限ります。

ブロッキングではない提案は、有益で簡潔なものにしてください。提案は残しても却下してもよく、Ready 判定を妨げることはありません。長所、一般的なセクションへのコメント、数値評価、恣意的な指摘件数を求めないでください。

出力

次に使われていないバージョン付きパスを使用します。 docs/design/reviews/<design-slug>/review-<NN>.md。リポジトリの規約で 別の永続的なパスが求められる場合は、以前の成果物を上書きせず、すべてのパスを保持します。

# Design Review: [title]

- Design: `docs/design/<file>.md`
- Reviewed: YYYY-MM-DD
- Mode: Initial | Follow-up
- Verdict: Ready | Not ready
- Mechanical validation: Pass | Fail
- Blocking findings: N
- Non-blocking suggestions: N

## Blocking Findings

### B1: [short title]
- Evidence:
- Impact:
- Required invariant:

## Non-Blocking Suggestions
- N1: [concise optional improvement]

## Prior Findings
- B1: Resolved | Unresolved | Regressed — [evidence]

## Handoff
- User decisions required:
- Affected story IDs:
- Recommended next action:

空の指摘セクションは省略するか、None と記載します。Ready とは、作成者モードでの機械的な検証に合格し、ブロッキング指摘が残っておらず、対象範囲内のストーリーを妨げる未解決の決定事項がない状態を指します。一度限りのレビュアーはこの判定を報告しますが、設計を Revised に昇格させることはありません。

コメント