Skip to content

Commit 606c37d

Browse files
🩹 [Patch]: Refactor templates to use tables for improved clarity and consistency in technical and functional requirements
1 parent 3570dc1 commit 606c37d

File tree

2 files changed

+55
-21
lines changed

2 files changed

+55
-21
lines changed

‎.specify/templates/plan-template.md‎

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -35,15 +35,17 @@
3535

3636
## Technical Context
3737

38-
**Language/Version**: [e.g., Python 3.11, Swift 5.9, Rust 1.75 or NEEDS CLARIFICATION]
39-
**Primary Dependencies**: [e.g., FastAPI, UIKit, LLVM or NEEDS CLARIFICATION]
40-
**Storage**: [if applicable, e.g., PostgreSQL, CoreData, files or N/A]
41-
**Testing**: [e.g., pytest, XCTest, cargo test or NEEDS CLARIFICATION]
42-
**Target Platform**: [e.g., Linux server, iOS 15+, Wasm or NEEDS CLARIFICATION]
43-
**Project Type**: [single/web/mobile - determines source structure]
44-
**Performance Goals**: [domain-specific, e.g., 1000 req/s, 10k lines/sec, 60 fps or NEEDS CLARIFICATION]
45-
**Constraints**: [domain-specific, e.g., <200ms p95, <100MB memory, offline-capable or NEEDS CLARIFICATION]
46-
**Scale/Scope**: [domain-specific, e.g., 10k users, 1M LOC, 50 screens or NEEDS CLARIFICATION]
38+
| Aspect | Details |
39+
|--------|---------|
40+
| **Language/Version** | [e.g., Python 3.11, Swift 5.9, Rust 1.75 or NEEDS CLARIFICATION] |
41+
| **Primary Dependencies** | [e.g., FastAPI, UIKit, LLVM or NEEDS CLARIFICATION] |
42+
| **Storage** | [if applicable, e.g., PostgreSQL, CoreData, files or N/A] |
43+
| **Testing** | [e.g., pytest, XCTest, cargo test or NEEDS CLARIFICATION] |
44+
| **Target Platform** | [e.g., Linux server, iOS 15+, Wasm or NEEDS CLARIFICATION] |
45+
| **Project Type** | [single/web/mobile - determines source structure] |
46+
| **Performance Goals** | [domain-specific, e.g., 1000 req/s, 10k lines/sec, 60 fps or NEEDS CLARIFICATION] |
47+
| **Constraints** | [domain-specific, e.g., <200ms p95, <100MB memory, offline-capable or NEEDS CLARIFICATION] |
48+
| **Scale/Scope** | [domain-specific, e.g., 10k users, 1M LOC, 50 screens or NEEDS CLARIFICATION] |
4749

4850
## Constitution Check
4951

‎.specify/templates/spec-template.md‎

Lines changed: 44 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -20,21 +20,53 @@
2020

2121
### Functional Requirements
2222

23-
- **FR-001**: System MUST [specific capability, e.g., "allow users to create accounts"]
24-
- **FR-002**: System MUST [specific capability, e.g., "validate email addresses"]
25-
- **FR-003**: Users MUST be able to [key interaction, e.g., "reset their password"]
26-
- **FR-004**: System MUST [data requirement, e.g., "persist user preferences"]
27-
- **FR-005**: System MUST [behavior, e.g., "log all security events"]
28-
29-
Example of marking unclear requirements:
30-
31-
- **FR-006**: System MUST authenticate users via [NEEDS CLARIFICATION: auth method not specified - email/password, SSO, OAuth?]
32-
- **FR-007**: System MUST retain user data for [NEEDS CLARIFICATION: retention period not specified]
23+
| ID | Requirement |
24+
|----|-------------|
25+
| **FR-001** | System MUST [specific capability, e.g., "allow users to create accounts"] |
26+
| **FR-002** | System MUST [specific capability, e.g., "validate email addresses"] |
27+
| **FR-003** | Users MUST be able to [key interaction, e.g., "reset their password"] |
28+
| **FR-004** | System MUST [data requirement, e.g., "persist user preferences"] |
29+
| **FR-005** | System MUST [behavior, e.g., "log all security events"] |
30+
| **FR-006** | System MUST authenticate users via [NEEDS CLARIFICATION: auth method not specified - email/password, SSO, OAuth?] |
31+
| **FR-007** | System MUST retain user data for [NEEDS CLARIFICATION: retention period not specified] |
32+
33+
### Non-Functional Requirements
34+
35+
| ID | Requirement |
36+
|----|-------------|
37+
| **NFR-001** | System MUST respond within [specific time, e.g., "500ms for 95th percentile"] |
38+
| **NFR-002** | System MUST handle [specific load, e.g., "1000 concurrent users"] |
39+
| **NFR-003** | System MUST maintain [availability target, e.g., "99.9% uptime"] |
40+
| **NFR-004** | System MUST scale to [capacity limit, e.g., "10,000 transactions per second"] |
41+
| **NFR-005** | System MUST recover within [time period, e.g., "5 minutes after failure"] |
42+
| **NFR-006** | System MUST encrypt data [NEEDS CLARIFICATION: encryption scope not specified - at rest, in transit, both?] |
43+
| **NFR-007** | System MUST maintain audit logs for [NEEDS CLARIFICATION: retention period not specified] |
44+
45+
### Quality Attributes Addressed
46+
47+
| Attribute | Target Metric |
48+
|-----------|---------------|
49+
| **Performance** | [e.g., "Response time < 200ms", "Throughput > 5000 TPS"] |
50+
| **Scalability** | [e.g., "Support 100,000 concurrent users", "Linear scaling to 10 nodes"] |
51+
| **Availability** | [e.g., "99.95% uptime", "Max 4 hours downtime per year"] |
52+
| **Reliability** | [e.g., "MTBF > 720 hours", "Error rate < 0.01%"] |
53+
| **Security** | [e.g., "OWASP Top 10 compliant", "SOC 2 Type II certified"] |
54+
| **Maintainability** | [e.g., "Code coverage > 80%", "Cyclomatic complexity < 10"] |
55+
| **Usability** | [e.g., "Task completion time < 2 minutes", "User satisfaction > 4.5/5"] |
56+
57+
### Constraints *(include if applicable)*
58+
59+
| Constraint | Description |
60+
|------------|-------------|
61+
| **[Constraint 1]** | [Limitation or restriction, e.g., "Must run on Windows Server 2019+"] |
62+
| **[Constraint 2]** | [Compliance requirement, e.g., "Must comply with GDPR"] |
3363

3464
### Key Entities *(include if feature involves data)*
3565

36-
- **[Entity 1]**: [What it represents, key attributes without implementation]
37-
- **[Entity 2]**: [What it represents, relationships to other entities]
66+
| Entity | Description |
67+
|--------|-------------|
68+
| **[Entity 1]** | [What it represents, key attributes without implementation] |
69+
| **[Entity 2]** | [What it represents, relationships to other entities] |
3870

3971
---
4072

0 commit comments

Comments
 (0)