product-specification-template.md

1# {{Product Name}} Product Specification
2
3**Last Updated**: {{YYYY-MM-DD}}
4
5> **Living Document**: This specification is actively maintained throughout the product lifecycle. It serves as the authoritative source for system capabilities and should be updated with each major or minor release to reflect new features and retired functionality.
6>
7> **Purpose**: Provides a technology-agnostic overview of system features for AI assistants, developers, and stakeholders. Should be referenced in the main README.md as essential reading for understanding system capabilities.
8>
9> **Maintenance**: AI assistants should recommend updates when implementing new features or discovering undocumented capabilities to keep this document aligned with the actual system.
10
11## Instructions for AI Assistants
12
13When working with this product specification:
14
151. **ID Format**: Use a letter prefix based on the logical grouping followed by 01-99:
16   - C01-C99: Core features (fundamental functionality)
17   - U01-U99: User management features
18   - A01-A99: API features
19   - M01-M99: Module-specific features
20   - S01-S99: Security features
21   - D01-D99: Data/Database features
22   - I01-I99: Integration features
23   - Choose appropriate prefix based on the feature's primary function
24
252. **Logical Groupings**: Create new sections when features share:
26   - Common functional area (e.g., authentication, reporting)
27   - Same user persona or journey
28   - Related business capability
29   - Similar technical components
30
313. **Writing Descriptions**: 
32   - Keep descriptions concise but complete
33   - Focus on WHAT not HOW (technical details go in technical specification)
34   - Include user value/benefit where applicable
35   - Be specific about scope and boundaries
36
374. **Target Version Guidelines**:
38   - MVP: Minimum viable product features
39   - v1: First MVP release
40   - v2, v3, etc.: Major version increments only
41   - Consider dependencies when assigning versions
42
435. **Priority Values**:
44   - P0: Critical - blocks other features or core functionality
45   - P1: High - important for target version success
46   - P2: Medium - valuable but not critical
47   - P3: Low - nice to have
48
496. **Status Values**:
50   - Not Started
51   - In Progress
52   - Complete
53   - Blocked (add blocker details in description)
54
557. **Document Maintenance**:
56   - Always update the "Last Updated" date at the top of the document when making changes
57   - Update status when features are completed
58   - Add new features as they're planned
59   - Move completed MVP features to show actual release version
60   - Archive obsolete features to a separate section
61   - Keep descriptions technology-agnostic for longevity
62
63## Overview
64
65[Brief description of the product and its purpose]
66
67## Core Features
68
69| ID | Feature Name | Description | Priority | Status | MVP | Target Version |
70|----|--------------|-------------|----------|--------|-----|----------------|
71| C01 | {{Feature}} | {{Description}} | P0 | Not Started | ✅ | MVP |
72| C02 | {{Feature}} | {{Description}} | P1 | Not Started | ❌ | v1 |
73
74## {{Logical Grouping Name}}
75
76| ID | Feature Name | Description | Priority | Status | MVP | Target Version |
77|----|--------------|-------------|----------|--------|-----|----------------|
78| {{X}}01 | {{Feature}} | {{Description}} | P1 | Not Started | ✅ | MVP |
79
80## Out of Scope
81
82| ID | Feature Name | Reason for Exclusion |
83|----|--------------|----------------------|
84| X01 | {{Feature}} | {{Reason}} |
85| X02 | {{Feature}} | {{Reason}} |
86
87## Glossary
88
89| Term | Definition |
90|------|------------|
91| {{Term}} | {{Definition}} |
92
93## Notes
94
95- {{Important considerations}}
96- {{Constraints or limitations}}
97- {{Key decisions made}}
98
99---
100
101*Template created by [Utaba AI](https://utaba.ai)*  
102*Source: [product-specification-template.md](https://ucm.utaba.ai/browse/utaba/main/guidance/templates/product-specification-template.md)*