Install any skill in seconds. Free to start, no credit card required.
Get Started Free →Documentation creation criteria including PRD, ADR, Design Doc, and Work Plan requirements with templates. Use when creating or reviewing technical documents, or determining which documents are required.
.claude/skills/shinpr-documentation-criteria/SKILL.md| Test case | Without → With | Effect | Δ tokens | Δ turns |
|---|---|---|---|---|
| case-11 | ✗→✓ | ▲ Improved | 0% | 0% |
| case-02 | ✗→✓ | ▲ Improved | 12% | 0% |
| case-03 | ✗→✓ | ▲ Improved | -4% | 0% |
| case-05 | ✗→✓ | ▲ Improved | 12% | 0% |
| case-06 | ✗→✓ | ▲ Improved | 2% | 0% |
このスキルはドキュメントの振り分け、すなわち変更に伴って記録すべき持続的な判断と各ドキュメントの保存先を定める。各ドキュメントの内容と構造の要件は、「保存場所」からリンクされた各テンプレートが定める。
| 構造スケール | 基本ドキュメント | 作成順序 | |-------------|----------------|---------| | 小規模 | なし | 直接実装 | | 中規模 | Design Doc、作業計画書 | Design Doc -> 作業計画書 | | 大規模 | PRD、Design Doc、作業計画書 | PRD -> Design Doc -> 作業計画書 |
フロントエンドまたはフルスタックの作業でUIに関する判断が未確定の場合は、Design Docの前にUI Specを追加する。適格なADRバッチはDesign Docの前に完了させる。適格なADRがある場合、スケールは最低でも中規模とする。
大規模変更のPRD要件は、新規PRDの作成、関連PRDの更新、現行のプロダクト文書がない場合のリバースPRD作成のいずれかで満たす。どのスケールでも、プロダクトスコープが変わる場合は既存PRDを更新する。
分類するのはリポジトリ上のレイアウトではなく判断負荷である。ファイル数は補助的なエビデンスにとどまる。
| スケール | 判断負荷 | |---------|---------| | 小規模 | まとまった成果が1つで、1つの責務境界の中にリポジトリが支持する明白な実装が1つあり、未解決の持続的な選択がない | | 中規模 | まとまった成果が1つで、境界の調整を伴うか、持続的になりうる選択を含む | | 大規模 | 独立して価値を持つ成果が複数あり、それぞれ別個の設計判断を要する |
レイヤーをまたぐ実装であっても、まとまった成果1つに資する場合は中規模のままでよい。
確認済みの実装スコープ内にある技術的な論点ごとに、選択(Choice)フィルタ、次いで持続性(Durability)フィルタを適用する。新たな記録を作る前に、受理済みADRを確認する。
両方のフィルタを通過した論点ごとにADRを1つ作成し、バッチ全体をまとめてレビューする。一緒に選択または再検討しなければならない判断はまとめ、独立して再検討できる判断は分ける。ローカルな実装詳細や、安価に元へ戻せるその他の選択はDesign Docに記載する。
| ドキュメント | パス | 命名規則 | テンプレート | |------------|-----|---------|------------| | PRD | docs/prd/ | [機能名]-prd.md | prd-template.md | | ADR | docs/adr/ | ADR-[4桁]-[タイトル].md | adr-template.md | | UI Spec | docs/ui-spec/ | [機能名]-ui-spec.md | ui-spec-template.md | | UI Specアセット | docs/ui-spec/assets/{feature-name}/ | プロトタイプコードファイル | - | | Design Doc | docs/design/ | [機能名]-design.md | design-template.md | | 作業計画書 | docs/plans/ | YYYYMMDD-{type}-{description}.md | plan-template.md | | タスクファイル | docs/plans/tasks/ | task-decomposerのファイル名表を参照 | task-template.md |
作業計画書は.gitignoreで除外される。
各テンプレートが、そのドキュメントの内容、ステータス規則、必要なエビデンス、任意の図、完了条件を定める。作成またはレビューするドキュメントのテンプレートだけを読み込む。
Other measured skills in the registry, with their headline benchmark lift.