pytest-stepfunctions の設計書や仕様メモを作成・更新した後に使う。README、TODO、既存 docs を照合し、厳しめに自己評価して不足を埋め、矛盾や収載漏れがない状態に整える。
pytest-stepfunctions の設計書や仕様メモを作成・更新した直後に使う。
対象ドキュメントを読み込み、自己評価し、不足点を修正し、README.md と TODO.md と矛盾しない状態まで仕上げる。
優先順は以下:
docs/design/*.mddocs/design/<feature>.md設計書がまだ存在しない場合は、必要に応じて docs/requirements.md も合わせて作成または更新対象に含める。
最低限、以下を確認する:
README.mdTODO.mddocs/requirements.md があればその内容src/ や tests/ があれば実装状況以下の 10 項目を各 10 点で採点する。
| # | 項目 | 観点 |
|---|---|---|
| 1 | 基本構造 | 概要、スコープ、設計、テスト、実装計画が揃っているか |
| 2 | 目的と非スコープ | 何を実装し、何をまだ実装しないかが明確か |
| 3 | 公開 API 設計 | fixture、marker、dataclass など利用者向け API が具体的か |
| 4 | backend 設計 | local、teststate、aws の扱いと責務分離が明確か |
| 5 | 設定と優先順位 | marker、CLI、設定ファイル、引数の優先順位が定義されているか |
| 6 | 異常系と制約 | timeout、認証不足、Local 未起動、quota などが考慮されているか |
| 7 | テスト戦略 | unit / integration の方針と具体ケースがあるか |
| 8 | 実装計画 | ファイル構成、段階分割、依存順が具体的か |
| 9 | ドキュメント整合性 | README.md と TODO.md と矛盾しないか |
| 10 | 実装着手可能性 | 実装者が追加質問なしで着手できるか |
採点基準:
評価結果は表でまとめ、合計点を出す。
評価で 9 点以下の項目は、具体的な修正タスクに落とす。
タスク粒度の目安:
修正ルール:
更新後に以下を確認する:
README.md の API 説明と設計書の公開 API が一致しているTODO.md の作業分解と設計書の実装計画が矛盾していない必要なら修正して再確認する。
最後に以下を簡潔に報告する:
docs/design/ がまだない場合は、必要に応じて新規作成を提案または実施するREADME.md だけでは設計詳細が足りない場合、設計書へ詳細を逃がす