documentation-criteria

Solid

PRD、ADR、Design Doc、UI Spec、作業計画書の作成を支援。技術ドキュメントの作成・レビュー時、または「UI Spec/画面設計/コンポーネント分解」が言及された時に使用。

AI & Automation 225 stars 24 forks Updated 1 weeks ago MIT

Install

View on GitHub

Quality Score: 88/100

Stars 20%
78
Recency 20%
90
Frontmatter 20%
70
Documentation 15%
100
Issue Health 10%
80
License 10%
100
Description 5%
100

Skill Content

# ドキュメント作成基準 ## 作成判定マトリクス | 構造スケール | 基本ドキュメント | 作成順序 | |-------------|----------------|---------| | 小規模 | なし | 直接実装 | | 中規模 | Design Doc、作業計画書 | Design Doc -> 作業計画書 | | 大規模 | PRD、Design Doc、作業計画書 | PRD -> Design Doc -> 作業計画書 | フロントエンド/フルスタックの作業では、Design Doc の前に UI Spec を追加する。適格なADRバッチは Design Doc の前に完了させる。適格なADRが存在する場合、スケー��は最低でも中規模に引き上げられる。 大規模変更のPRD要件は、新規PRDの作成、関連PRDの更新、現行の製品文書がない場合のリバースPRD作成のいずれかで満たす。どのスケールでも、プロダクトスコープが変わる場合は既存PRDを更新する。 ## 構造スケール(Structural Scale) 分類するのはリポジトリ上のレイアウトではなく判断負荷である。ファイル数は補助的なエビデンスにとどまる。 | スケール | 判断負荷 | |---------|---------| | 小規模 | まとまった成果が1つで、1つの責務境界の中にリポジトリが支持する明白な実装が1つあり、未解決の持続的な選択がない | | 中規模 | まとまった成果が1つで、境界をまたいだ調整を伴うか、持続的になりうる選択を含む | | 大規模 | 独立して価値を持つ成果が複数あり、それぞれ別個の設計判断を要する | レイヤーをまたぐ実装であっても、まとまった成果1つに資する場合は中規模のままでよい。適格なADRが存在する場合、スケールは最低でも中規模に引き上げられる。 ## ADR判定フィルタ ADRを作成するのは、候補となる決定が両方のフィルタを通過する場合に限る: 1. **選択に判断を要する(Choice)**: 確認済み要件・受理済みADR・リポジトリのエビデンスを適用した後も、妥当かつ実質的に異なる選択肢が2つ以上残る。 2. **選択が持続的である(Durability)**: その選択が、後続の作業が維持しなければならない責務境界・依存・共有契約・永続化モデル・技術・可逆性・ライフサイ��ルコストのいずれかを変える。 決定ポイント1つにつきADRを1つ作成する。分離すると双方の決定が誤解を招く場合に限り、密結合した選択をまとめる。 しばしば適格となる例としては、外部依存の選定・置換、アーキテクチャ境界をまたぐ所有権の移動、永続化戦略の変更、共有契約の確立などがある。ローカルな実装詳細や容易に元へ戻せる選択は Design Doc に属する。ファイル数・ネストの深さ���状態数・パイプラインの長さは複雑性のエビデンスであって、ADRのトリガーではない。 ## 各ドキュメントの詳細定義 ### PRD(Product Requirements Document) **目的**: ビジネス要件とユーザー価値を定義 **含むもの**: - ビジネス要件とユーザー価値 - 成功指標とKPI(各指標に数値目標、測定方法、期間を明記) - ユーザーストーリーとユースケース - 受入条件(AC)に連番ID(AC-001, AC-002, ...)を付与し、下流でのトレーサビリティを確保 - MVPへの収束 — ...

Details

Author
shinpr
Repository
shinpr/ai-coding-project-boilerplate
Created
1 years ago
Last Updated
1 weeks ago
Language
JavaScript
License
MIT

Similar Skills

Semantically similar based on skill content — not just same category

AI & Automation Featured

documentation-criteria

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.

664 Updated 2 weeks ago
shinpr
Web & Frontend Solid

enterprise-prd-writer

企業 PRD Writer — 受監管 / 金流 / 風控 / 跨職能團隊等級的產品需求文件撰寫與強化工具, 用於產出可直接進入 Refinement、Engineering Design、Development、QA 與 UAT 的 「施工藍圖」等級文件。相對於輕量版 prd-writer,此版本額外涵蓋權限矩陣、NFR、 依賴管理、合規、Analytics/Observability、Rollout/Migration/Rollback 與 UAT/Release Readiness。 預設以 interactive-html-report 規格輸出互動式 HTML(含常駐目錄側欄、捲動高亮)。 ⚠️ 版本選擇(重要): 當使用者說「幫我寫 PRD」但未指明版本時,先問使用者要用「輕量版(prd-writer)」 還是「企業版(本 skill)」再開始。判斷提示:個人專案 / 單一功能 / 無合規需求 → 輕量版; 多團隊 / 金流 / 風控 / 合規 / 需上線維運全鏈路 → 企業版。使用者已明確指定版本時直接照做,不必再問。 當使用者提出以下需求時,應優先使用此 skill: - 幫我寫 PRD - 產品需求文件 - 寫 spec / feature spec - 功能規格 / 需求規格書 - write a PRD / product requirements - 產品設計文件 - 幫我整理這個功能的規格 - 把這個想法寫成文件 - 我要交一份產品文件給工程團隊 - 寫個規格讓工程師可以直接開工 - 補 AC / 驗收標準 - 補 Out of Scope - 補畫面狀態 - 補 Edge Cases - 補權限矩陣 - 補 NFR - 補 Rollout / Rollback - 強化既有 PRD 此 skill 的目標不是產出冗長文件,而是建立可執行、可測試、可追蹤、 可討論且邊界明確的產品規格,降低因需求模糊造成的返工與認知落差。 核心強制項目包含: - Acceptance Criteria - Edge Case Analysis - Screen / System States - In Scope / Out of Scope - Assumptions / Open Questions / Decisions - Dependencies - Roles & Permissions -

42 Updated 4 weeks ago
skinnerlee1225
Data & Documents Listed

d1-product-requirement-document

プロダクト要求仕様書(PRD)の新規作成・更新・レビューを支援する。AI駆動開発成果物フローのビジネス要求(D1)に位置する成果物で、方針・概念・体験設計・制約・受け入れ基準を扱う文書。具体的な横断要求(機能要求・非機能要求・UI/UX・セキュリティ・法務 等)は独立成果物のドメイン共通要求仕様書に集約し、PRD は要求 ID を持たない。BRD・アクター一覧・ドメイン定義書 を上流とし、BRD策定後、ドメイン共通要求仕様書の作成前に呼び出す。

6 Updated 2 weeks ago
Acceler-Digital