mirror of
https://github.com/github/spec-kit.git
synced 2026-01-31 13:03:36 +00:00
392dbf20c4
- Add upgrading-spec-kit.md with detailed upgrade instructions and troubleshooting - Update table of contents to include upgrading guide in Getting Started section - Update documentation index and README links - Address user questions about updating initialized projects from GitHub discussions Co-authored-by: GitHub Copilot <github.copilot@github.com> Signed-off-by: Ashley Childress <6563688+anchildress1@users.noreply.github.com>
68 lines
3.2 KiB
Markdown
68 lines
3.2 KiB
Markdown
# Spec Kit
|
|
|
|
*Build high-quality software faster.*
|
|
|
|
**An effort to allow organizations to focus on product scenarios rather than writing undifferentiated code with the help of Spec-Driven Development.**
|
|
|
|
## What is Spec-Driven Development?
|
|
|
|
Spec-Driven Development **flips the script** on traditional software development. For decades, code has been king — specifications were just scaffolding we built and discarded once the "real work" of coding began. Spec-Driven Development changes this: **specifications become executable**, directly generating working implementations rather than just guiding them.
|
|
|
|
## Getting Started
|
|
|
|
- [Installation Guide](installation.md) - First-time installation of Spec Kit
|
|
- [Quick Start Guide](quickstart.md) - Start a new project with Spec Kit
|
|
- [Upgrading Spec Kit](upgrading-spec-kit.md) - Update CLI and project files
|
|
- [Local Development](local-development.md) - Contribute to Spec Kit development
|
|
|
|
## Core Philosophy
|
|
|
|
Spec-Driven Development is a structured process that emphasizes:
|
|
|
|
- **Intent-driven development** where specifications define the "*what*" before the "*how*"
|
|
- **Rich specification creation** using guardrails and organizational principles
|
|
- **Multi-step refinement** rather than one-shot code generation from prompts
|
|
- **Heavy reliance** on advanced AI model capabilities for specification interpretation
|
|
|
|
## Development Phases
|
|
|
|
| Phase | Focus | Key Activities |
|
|
|-------|-------|----------------|
|
|
| **0-to-1 Development** ("Greenfield") | Generate from scratch | <ul><li>Start with high-level requirements</li><li>Generate specifications</li><li>Plan implementation steps</li><li>Build production-ready applications</li></ul> |
|
|
| **Creative Exploration** | Parallel implementations | <ul><li>Explore diverse solutions</li><li>Support multiple technology stacks & architectures</li><li>Experiment with UX patterns</li></ul> |
|
|
| **Iterative Enhancement** ("Brownfield") | Brownfield modernization | <ul><li>Add features iteratively</li><li>Modernize legacy systems</li><li>Adapt processes</li></ul> |
|
|
|
|
## Experimental Goals
|
|
|
|
Our research and experimentation focus on:
|
|
|
|
### Technology Independence
|
|
|
|
- Create applications using diverse technology stacks
|
|
- Validate the hypothesis that Spec-Driven Development is a process not tied to specific technologies, programming languages, or frameworks
|
|
|
|
### Enterprise Constraints
|
|
|
|
- Demonstrate mission-critical application development
|
|
- Incorporate organizational constraints (cloud providers, tech stacks, engineering practices)
|
|
- Support enterprise design systems and compliance requirements
|
|
|
|
### User-Centric Development
|
|
|
|
- Build applications for different user cohorts and preferences
|
|
- Support various development approaches (from vibe-coding to AI-native development)
|
|
|
|
### Creative & Iterative Processes
|
|
|
|
- Validate the concept of parallel implementation exploration
|
|
- Provide robust iterative feature development workflows
|
|
- Extend processes to handle upgrades and modernization tasks
|
|
|
|
## Contributing
|
|
|
|
Please see our [Contributing Guide](https://github.com/github/spec-kit/blob/main/CONTRIBUTING.md) for information on how to contribute to this project.
|
|
|
|
## Support
|
|
|
|
For support, please check our [Support Guide](https://github.com/github/spec-kit/blob/main/SUPPORT.md) or open an issue on GitHub.
|