prd-template.md
1 --- 2 type: template 3 status: reference 4 tags: 5 - template 6 - PRD 7 - product-development 8 related: 9 - "[[DES-intention-capability-synthesis]]" 10 - "[[MEMBRANE-AS-API]]" 11 - "[[design-doc-template]]" 12 --- 13 14 # Product Requirements Document Template 15 16 > **Template for PRDs that include organizational membrane sections.** 17 > Location: `docs/product/PRD-{PRODUCT-NAME}.md` 18 19 --- 20 21 ## Template 22 23 ```markdown 24 --- 25 session: "[[{YYYY-MM-DD}]]" 26 parent: "[[Product]]" 27 tags: 28 - PRD 29 - {product-tag} 30 - {domain-tags} 31 status: draft | in-progress | complete 32 owner: {owner} 33 created: {YYYY-MM-DD} 34 product_roadmap: "[[ROADMAP-{PRODUCT}]]" # Link to product-specific roadmap 35 uber_roadmap_items: ['{thread-xxx}'] # Link to Uber Roadmap items this serves 36 principles: 37 - "[[{relevant-principles}]]" 38 --- 39 40 # PRD: {Product Name} 41 42 **Product Requirements Document** 43 44 --- 45 46 ## Executive Summary 47 48 {2-3 paragraph high-level summary of what this product is and why it matters} 49 50 --- 51 52 ## Problem Statement 53 54 ### Current State 55 56 {What exists today? What's broken or missing?} 57 58 ### Impact 59 60 {What's the cost of the current state? Who suffers?} 61 62 ### Opportunity 63 64 {What becomes possible if we solve this?} 65 66 --- 67 68 ## Organizational Membrane (A0 ALIGNMENT) 69 70 > **What this product shares with the organization vs what it owns internally** 71 > See: [[DES-intention-capability-synthesis]] 72 73 ### Intentions (What We Need - PUBLISHED TO UBER ROADMAP) 74 75 These are published for cross-product synthesis. Other products may have what we need. 76 77 | Intention ID | Problem We're Solving | Capability Needed | Timeline | Open to Collab | 78 |--------------|----------------------|-------------------|----------|----------------| 79 | INT-001 | {problem} | {capability} | {Q# YYYY} | Yes/No | 80 | INT-002 | {problem} | {capability} | {Q# YYYY} | Yes/No | 81 82 **API Contract for INT-001** (expand for each intention): 83 ```yaml 84 intention: 85 id: INT-001 86 problem: "{problem statement}" 87 88 capability_sought: 89 description: "{what we need}" 90 interface_requirements: 91 input_we_provide: 92 type: object 93 properties: 94 # What we'll send 95 output_we_need: 96 type: object 97 properties: 98 # What we expect back 99 100 acceptance_criteria: 101 latency_max: 500ms 102 availability_min: 99% 103 data_format: "JSON" 104 105 integration_budget: 106 effort: "2 sprints" 107 dependencies: [] 108 ``` 109 110 ### Capabilities Offered (What We Provide - PUBLISHED TO UBER ROADMAP) 111 112 These can be discovered by other products. We build once, benefit many. 113 114 | Capability ID | Name | Description | Available When | Effort to Integrate | 115 |---------------|------|-------------|----------------|---------------------| 116 | CAP-001 | {name} | {description} | {Q# YYYY} | Low/Med/High | 117 118 **API Contract for CAP-001** (expand for each capability): 119 ```yaml 120 capability: 121 id: CAP-001 122 name: "{name}" 123 version: 1.0.0 124 125 interface: 126 input_schema: 127 type: object 128 properties: 129 # Define input parameters 130 output_schema: 131 type: object 132 properties: 133 # Define output format 134 135 sla: 136 availability: 99.9% 137 latency_p50: 50ms 138 latency_p99: 200ms 139 140 constraints: 141 rate_limit: "100 req/min" 142 max_payload: "1MB" 143 144 versioning: 145 deprecation_policy: "6 month notice" 146 breaking_changes: "Major version bump" 147 ``` 148 149 ### Constraints to Broadcast (What Limits Us - SHARED WITH ORG) 150 151 Other products should know these constraints when considering collaboration: 152 153 - {Constraint 1: e.g., "Must maintain <100ms latency"} 154 - {Constraint 2: e.g., "Offline-first, cannot assume connectivity"} 155 156 ### Strategic Alignment (How This Serves Org Goals) 157 158 - **Serves Uber Roadmap Item**: [[thread-xxx]] - {description} 159 - **Enables**: {What other products/features does this enable?} 160 - **Blocks if Missing**: {What breaks without this?} 161 162 ### Internal Scope (STAYS OPAQUE TO ORG) 163 164 > These aspects are internal to the product team: 165 166 - Implementation architecture decisions 167 - Sprint planning and team velocity 168 - Technical debt prioritization 169 - Internal quality tradeoffs 170 - Resource allocation within team 171 172 --- 173 174 ## User Stories 175 176 ### {User Type 1} 177 178 **US-1: {Story Title}** 179 > As a {role}, I want {capability}, so that {benefit}. 180 181 ### {User Type 2} 182 183 **US-2: {Story Title}** 184 > As a {role}, I want {capability}, so that {benefit}. 185 186 --- 187 188 ## Requirements 189 190 ### Functional Requirements 191 192 #### FR-1: {Requirement Name} 193 194 {Detailed requirement description} 195 196 | Aspect | Value | 197 |--------|-------| 198 | Priority | P0/P1/P2 | 199 | Complexity | Low/Med/High | 200 | Dependencies | {list} | 201 202 ### Non-Functional Requirements 203 204 #### NFR-1: {Requirement Category} 205 206 {Performance, security, usability, etc. requirements} 207 208 --- 209 210 ## Architecture 211 212 ### Component Diagram 213 214 ``` 215 {ASCII diagram of major components} 216 ``` 217 218 ### Data Model 219 220 ```typescript 221 {Key interfaces/types} 222 ``` 223 224 --- 225 226 ## Implementation Phases 227 228 ### Phase 1: {Name} (Week X-Y) 229 230 - [ ] {Milestone 1} 231 - [ ] {Milestone 2} 232 233 **Deliverable:** {What's usable after this phase} 234 235 ### Phase 2: {Name} (Week X-Y) 236 237 - [ ] {Milestone 1} 238 - [ ] {Milestone 2} 239 240 **Deliverable:** {What's usable after this phase} 241 242 --- 243 244 ## Success Metrics 245 246 ### Adoption 247 248 | Metric | Target | Measurement | 249 |--------|--------|-------------| 250 | {metric} | {target} | {how measured} | 251 252 ### Performance 253 254 | Metric | Target | Measurement | 255 |--------|--------|-------------| 256 | {metric} | {target} | {how measured} | 257 258 --- 259 260 ## Dependencies 261 262 - **{Dependency 1}** - {What and why} 263 - **{Dependency 2}** - {What and why} 264 265 --- 266 267 ## Risks & Mitigations 268 269 | Risk | Likelihood | Impact | Mitigation | 270 |------|------------|--------|------------| 271 | {risk} | Low/Med/High | Low/Med/High | {mitigation} | 272 273 --- 274 275 ## Open Questions 276 277 1. **{Question}**: {Context, options being considered} 278 2. **{Question}**: {Context, options being considered} 279 280 --- 281 282 ## Appendices 283 284 ### A. Related Documents 285 286 - [[{Related PRD}]] - {Description} 287 - [[{Design Doc}]] - {Description} 288 - [[{Principle}]] - {Description} 289 290 ### B. Provenance Chain 291 292 ``` 293 Uber Roadmap Item: [[thread-xxx]] 294 └── This PRD: [[PRD-{PRODUCT}]] 295 └── Product Roadmap: [[ROADMAP-{PRODUCT}]] 296 ├── Design: [[DES-xxx]] 297 └── Design: [[DES-yyy]] 298 ``` 299 300 --- 301 302 *PRD: {Product Name} v{version} | {date} | Owner: {owner}* 303 ``` 304 305 --- 306 307 ## Usage Notes 308 309 ### Membrane Sections are Required 310 311 The **Organizational Membrane** section is mandatory. It ensures: 312 1. Your product's needs are visible for synthesis 313 2. Your capabilities are discoverable by other products 314 3. Constraints are broadcast to prevent incompatible decisions 315 4. Internal scope is protected from organizational overreach 316 317 ### Linking to Roadmaps 318 319 Every PRD should link to: 320 - **Product Roadmap** (`ROADMAP-{PRODUCT}.md`) - Your team's detailed plan 321 - **Uber Roadmap Items** - Which organizational-level items this serves 322 323 ### Provenance Chain 324 325 Maintain the chain: `Uber Roadmap → PRD → Product Roadmap → Designs → Sessions` 326 327 --- 328 329 ## Maturation Ladder Integration 330 331 PRDs are assessed by the maturation system: 332 - **EMERGENT**: PRD exists with basic structure 333 - **STRUCTURED**: Membrane sections complete, user stories defined 334 - **INTEGRATED**: Linked to roadmaps, provenance tracked 335 - **SOVEREIGN**: Active synthesis (collaboration opportunities acted on) 336 337 --- 338 339 ## Checklist 340 341 - [ ] Executive summary present 342 - [ ] Problem statement clear 343 - [ ] Organizational membrane section complete 344 - [ ] Intentions declared 345 - [ ] Capabilities declared 346 - [ ] Constraints broadcast 347 - [ ] Strategic alignment stated 348 - [ ] User stories written 349 - [ ] Functional requirements specified 350 - [ ] Architecture diagram present 351 - [ ] Success metrics defined 352 - [ ] Linked to Uber Roadmap item(s) 353 - [ ] Linked to Product Roadmap 354 - [ ] Provenance chain documented 355 356 --- 357 358 *Template: PRD | v2.0 | Includes Organizational Membrane*