[PROJECT NAME]: [Concise Subtitle]
[One-sentence value proposition]
[2-3 paragraph introduction]
Executive Summary
What: [2-3 sentences describing the system]
Why: [2-3 sentences explaining the problem]
How: [2-3 sentences on the unique approach]
Proof: [2-3 sentences referencing proven technologies]
Problem Statement
[Primary Challenge]
[Explanation with specific metrics and examples]
[Secondary Challenge]
[Additional context if needed]
Solution Architecture
[Core Component 1]
[Technical approach explanation]
Architecture:
[ASCII diagram or pseudocode]Key Features:
- Feature with metric
- Feature with metric
- Feature with metric
[Core Component 2]
[Continue for each major component]
Implementation Plan
Phase 1: [Foundation] (Timeframe)
Milestones:
- Milestone 1: [Specific deliverable]
- Milestone 2: [Specific deliverable]
- Milestone 3: [Specific deliverable]
Phase 2: [Development] (Timeframe)
[Continue pattern]
Quick Start
Installation
# Installation commandsBasic Usage
// Simple example showing core functionalityCore Examples
Example 1: [Common Use Case]
// Complete working exampleExample 2: [Another Use Case]
[Continue for 2-4 key examples]
Performance & Benchmarks
| Metric | Value | Comparison |
|---|---|---|
| Startup | Xms | Baseline: Yms |
| Throughput | N ops/sec | Baseline: M ops/sec |
| Memory | Z MB | Baseline: W MB |
Configuration
{
"key_option_1": "default",
"key_option_2": 100,
"advanced_options": {
// Optional configurations
}
}Testing
Test Coverage
- Unit tests: X% coverage
- Integration tests: Y scenarios
- Performance tests: Z benchmarks
Running Tests
# Test commandsRoadmap
Next (Months 1-3)
- Feature 1
- Feature 2
- Feature 3
Future (Months 4-12)
- Advanced feature 1
- Advanced feature 2
Conclusion
Key Differentiators:
- Performance: [Specific metric or capability]
- Reliability: [Specific metric or capability]
- Usability: [Specific metric or capability]
- Extensibility: [Specific metric or capability]
[Final 2-3 sentence summary]
Resources
- Documentation: [link]
- Repository: [link]
- Examples: [link]
Status: [Version X.Y.Z - Status - Last Updated]
License: [License Type]
Contact: [Author/Organization]
QUICK TEMPLATE NOTES
When to Use This Template
Use this condensed version when:
- [ ] Spec is for internal team (less context needed)
- [ ] Project is relatively straightforward
- [ ] Timeline is short (❤️ months)
- [ ] Audience is already familiar with domain
- [ ] Emphasis is on speed over comprehensiveness
When to Use Full Template
Use the comprehensive template when:
- [ ] Spec is for external stakeholders
- [ ] Project is complex or novel
- [ ] Timeline is extended (3+ months)
- [ ] Audience needs significant context
- [ ] Detail and proof are critical
Minimum Required Sections
- Executive Summary - Always include
- Problem Statement - Establish need
- Solution Architecture - Show approach
- Implementation Plan - Demonstrate feasibility
- Conclusion - Synthesize value
Quick Filling Guide
- Start with Executive Summary - If you can't fill these 4 questions concisely, you need more clarity on the project
- Add metrics everywhere - Replace adjectives with numbers
- Show, don't tell - Include code/diagrams, not just descriptions
- Cite precedent - Reference existing successful systems
- Be realistic - Honest about limitations and tradeoffs
Expansion Path
To convert this quick template to the full template:
- Expand Problem Statement → Add threat analysis or detailed context
- Add Technical Deep Dive → Create new section after Architecture
- Expand Examples → Add 2-3 more use cases
- Add Models section → Performance/cost formulas
- Expand Testing → Add security/integration details
- Add Integration section → Platform-specific guides
- Expand Documentation → Link to comprehensive docs
Pro tip: Start with this quick template to get ideas on paper, then expand sections that need more detail. Don't write the full template if this one suffices for your audience.