You want to build software. The official Spec-Kit docs are good, but they're dense.
You read them โ You get confused โ You make mistakes โ You don't know what to do when things break.
|
|
This is what you won't find anywhere else.
You run: /speckit.implement
Something breaks: โ Error!
You think: "Now what?" ๐ฐ
| Question | Answer |
|---|---|
| ๐ What type of error? | Build / Runtime / Test / Deployment |
| ๐ฏ What caused it? | Bad spec? Bad plan? Bad code? |
| โฉ๏ธ Where to go back? | Exact command to fix it |
| ๐ ๏ธ How to fix it? | Step-by-step recovery |
โ Problem: Tests fail after implementation
โ
Solution:
1. Run /speckit.analyze
2. Find the mismatch (spec vs code)
3. Fix at the source
4. Re-run from there
Simple. Clear. Done.| Guide | Purpose | Size | Audience |
|---|---|---|---|
| ๐ Quick Guide | Get started in minutes with visual workflows | โก Fast | Beginners, Rapid start |
| ๐ Comprehensive Guide | Complete technical reference with all details | ๐ Deep | Advanced users, Teams |
๐ Quick Guide Contents (Click to expand)
- 5-Minute Quick Start - Install and build your first feature
- Visual Workflows - Mermaid diagrams for every process
- Core Commands - What each command does and when to use it
- Brownfield Integration - Easy steps for existing projects
- Checklist Usage - When and how to use quality checklists
- Error Recovery - What to do when things break
- Common Scenarios - Real-world examples and patterns
- Quick Reference - Cheat sheets and file locations
๐ Comprehensive Guide Contents (Click to expand)
- System Architecture - Detailed technical architecture
- Advanced Installation - All configuration options
- Command Deep Dive - Exhaustive command documentation
- Brownfield Project Integration - Complete integration strategies
- Constitutional Governance - Nine Articles framework
- Advanced Workflow Patterns - Multi-feature, iterative development
- Template Customization - Create your own templates
- Error Recovery & Debugging - Systematic troubleshooting
- Multi-Agent Strategies - Using different AI agents effectively
- CI/CD Integration - Pipeline automation and quality gates
- Performance & Optimization - Making Spec-Kit faster
- Troubleshooting Reference - Complete error reference
- Best Practices & Patterns - Team collaboration patterns
# 1. Install uv
curl -LsSf https://astral.sh/uv/install.sh | sh
# 2. Install Spec-Kit
uv tool install specify-cli --from git+https://github.com/github/spec-kit.git
# 3. Initialize
cd your-project
specify init --here
# 4. Build your feature
/speckit.constitution
/speckit.specify "Your feature description"
/speckit.plan
/speckit.tasks
/speckit.implement|
You'll understand what's happening and why. No confusion. No guessing. |
You'll fix errors faster with recovery workflows. No wasted time. No frustration. |
|
You'll have consistent practices with Constitutional Governance. No conflicts. No technical debt. |
You'll see real examples, not abstract theory. No confusion. No gaps. |
The official Spec-Kit is powerful. But power without clarity is frustrating.
| Official Docs | This Guide |
|---|---|
| โ What the tool does | โ How to actually use it |
| โ Technical reference | โ What to do when it breaks |
| โ Core features | โ Real-world examples |
Both are needed. Use both.
Always check the official repository for updates.
- github/spec-kit - Main repository
- Official README - Core docs
- Spec-Driven Development - Philosophy
- amrpyt/spec-kit-guide - Documentation repository
- ๐ Quick Guide - Get started in minutes
- ๐ Comprehensive Guide - Complete technical reference
- README-AR.md - Arabic version (Al-Hariri style)
|
Open an issue |
Submit a pull request |
We'll review it |
See CONTRIBUTING.md for details.
MIT License - Same as the original Spec-Kit project.
It helps others find it.
Made with โค๏ธ by the community
Based on github/spec-kit
๐ Quick Guide โข ๐ Comprehensive Guide โข ๐ธ๐ฆ ุงููุณุฎุฉ ุงูุนุฑุจูุฉ