规范驱动开发
- 作者仓库星标 48,015
- 作者仓库 agent-skills
- 领域
- 工程开发
- 作者声明的智能体
- 未找到明确声明;不据此推断已兼容或已测试
- 静态检查
- 88 / 100 · 启发式扫描,不代表运行安全
- 运行环境证据
- 未执行;当前没有隔离运行测试证据
- 作者 / 版本 / 许可证
- @addyosmani · 未声明许可证
- 上下文用量评级
- 低消耗
- 接入复杂程度
- 需简单配置
- 是否需要外部接口密钥
- 不需要
- 兼容的系统
- macOS · Linux · Windows
- 运行环境要求
- 未检出明确要求
- 检测到的文件与系统行为
-
- 只读
- 允许写入 / 修改
- 命令执行
- 网络行为
- 仅限本地
- 安装命令数
- 无(仅作为资料)
需要注意: 未声明工具权限范围;实际权限由运行环境决定。
第一阶段:指定
从高层次的愿景开始。询问人类澄清问题,直到需求具体化。立即提出假设。在编写任何规范内容之前,请列出您的假设:不要默默地填写不明确的要求。该规范的全部目的是在编写代码之前*揭露误解——假设是最危险的误解形式。编写涵盖这六个核心领域的规范文档:
第二阶段:计划
使用经过验证的规范,生成技术实施计划: 确定主要组件及其依赖关系 确定实施顺序(必须首先构建什么) 注意风险和缓解策略 确定可以并行构建的内容与必须顺序构建的内容
第三阶段:任务
将计划分解为离散的、可实施的任务: 每个任务都应该在单个重点会话中完成 每个任务都有明确的验收标准 每个任务都包含一个验证步骤(测试、构建、手动检查) 任务按依赖性排序,而不是按感知的重要性排序
第四阶段:实施
按照`skills/incremental-implementation/SKILL.md`(`incremental-implementation`)和`skills/test-driven-development/SKILL.md`(`test-driven-development`)一次执行一个任务。使用 `skills/context-engineering/SKILL.md` (`context-engineering`) 在每一步加载正确的规范部分和源文件,而不是用整个规范淹没代理。
# Spec-Driven Development
## Overview
Write a structured specification before writing any code. The spec is the shared source of truth between you and the human engineer — it defines what we're building, why, and how we'll know it's done. Code without a spec is guessing.
## When to Use
- Starting a new project or feature
- Requirements are ambiguous or incomplete
- The change touches multiple files or modules
- You're about to make an architectural decision
- The task would take more than 30 minutes to implement
**When NOT to use:** Single-line fixes, typo corrections, or changes where requirements are unambiguous and self-contained.
## The Gated Workflow
Spec-driven development has four phases. Do not advance to the next phase until the current one is validated.
```
SPECIFY ──→ PLAN ──→ TASKS ──→ IMPLEMENT
│ │ │ │
▼ ▼ ▼ ▼
Human Human Human Human
reviews reviews reviews reviews
```
### Phase 1: Specify
Start with a high-level vision. Ask the human clarifying questions until requirements are concrete.
**Surface assumptions immediately.** Before writing any spec content, list what you're assuming:
```
ASSUMPTIONS I'M MAKING:
1. This is a web application (not native mobile)
2. Authentication uses session-based cookies (not JWT)
3. The database is PostgreSQL (based on existing Prisma schema)
4. We're targeting modern browsers only (no IE11)
→ Correct me now or I'll proceed with these.
```
Don't silently fill in ambiguous requirements. The spec's entire purpose is to surface misunderstandings *before* code gets written — assumptions are the most dangerous form of misunderstanding.
**Write a spec document covering these six core areas:**
1. **Objective** — What are we building and why? Who is the user? What does success look like?
2. **Commands** — Full executable commands with flags, not just tool names.
```
Build: npm run build
Test: npm test -- --coverage
Lint: npm run lint --fix
Dev: npm run dev
```
3. **Project Structure** — Where source code lives, where tests go, where docs belong.
```
src/ → Application source code
src/components → React components
src/lib → Shared utilities
tests/ → Unit and integration tests
e2e/ → End-to-end tests
docs/ → Documentation
```
4. **Code Style** — One real code snippet showing your style beats three paragraphs describing it. Include naming conventions, formatting rules, and examples of good output.
5. **Testing Strategy** — What framework, where tests live, coverage expectations, which test levels for which concerns.
6. **Boundaries** — Three-tier system:
- **Always do:** Run tests before commits, follow naming conventions, validate inputs
- **Ask first:** Database schema changes, adding dependencies, changing CI config
- **Never do:** Commit secrets, edit vendor directories, remove failing tests without approval
**Spec template:**
```markdown
# Spec: [Project/Feature Name]
## Objective
[What we're building and why. User stories or acceptance criteria.]
## Tech Stack
[Framework, language, key dependencies with versions]
## Commands
[Build, test, lint, dev — full commands]
## Project Structure
[Directory layout with descriptions]
## Code Style
[Example snippet + key conventions]
## Testing Strategy
[Framework, test locations, coverage requirements, test levels]
## Boundaries
- Always: [...]
- Ask first: [...]
- Never: [...]
## Success Criteria
[How we'll know this is done — specific, testable conditions]
## Open Questions
[Anything unresolved that needs human input]
```
**Reframe instructions as success criteria.** When receiving vague requirements, translate them into concrete conditions:
```
REQUIREMENT: "Make the dashboard faster"
REFRAMED SUCCESS CRITERIA:
- Dashboard LCP < 2.5s on 4G connection
- Initial data load completes in < 500ms
- No layout shift during load (CLS < 0.1)
→ Are these the right targets?
```
This lets you loop, retry, and problem-solve toward a clear goal rather than guessing what "faster" means.
### Phase 2: Plan
With the validated spec, generate a technical implementation plan:
1. Identify the major components and their dependencies
2. Determine the implementation order (what must be built first)
3. Note risks and mitigation strategies
4. Identify what can be built in parallel vs. what must be sequential
5. Define verification checkpoints between phases
The plan should be reviewable: the human should be able to read it and say "yes, that's the right approach" or "no, change X."
### Phase 3: Tasks
Break the plan into discrete, implementable tasks:
- Each task should be completable in a single focused session
- Each task has explicit acceptance criteria
- Each task includes a verification step (test, build, manual check)
- Tasks are ordered by dependency, not by perceived importance
- No task should require changing more than ~5 files
**Task template:**
```markdown
- [ ] Task: [Description]
- Acceptance: [What must be true when done]
- Verify: [How to confirm — test command, build, manual check]
- Files: [Which files will be touched]
```
### Phase 4: Implement
Execute tasks one at a time following `skills/incremental-implementation/SKILL.md` (`incremental-implementation`) and `skills/test-driven-development/SKILL.md` (`test-driven-development`). Use `skills/context-engineering/SKILL.md` (`context-engineering`) to load the right spec sections and source files at each step rather than flooding the agent with the entire spec.
## Keeping the Spec Alive
The spec is a living document, not a one-time artifact:
- **Update when decisions change** — If you discover the data model needs to change, update the spec first, then implement.
- **Update when scope changes** — Features added or cut should be reflected in the spec.
- **Commit the spec** — The spec belongs in version control alongside the code.
- **Reference the spec in PRs** — Link back to the spec section that each PR implements.
## Common Rationalizations
| Rationalization | Reality |
|---|---|
| "This is simple, I don't need a spec" | Simple tasks don't need *long* specs, but they still need acceptance criteria. A two-line spec is fine. |
| "I'll write the spec after I code it" | That's documentation, not specification. The spec's value is in forcing clarity *before* code. |
| "The spec will slow us down" | A 15-minute spec prevents hours of rework. Waterfall in 15 minutes beats debugging in 15 hours. |
| "Requirements will change anyway" | That's why the spec is a living document. An outdated spec is still better than no spec. |
| "The user knows what they want" | Even clear requests have implicit assumptions. The spec surfaces those assumptions. |
## Red Flags
- Starting to write code without any written requirements
- Asking "should I just start building?" before clarifying what "done" means
- Implementing features not mentioned in any spec or task list
- Making architectural decisions without documenting them
- Skipping the spec because "it's obvious what to build"
## Verification
Before proceeding to implementation, confirm:
- [ ] The spec covers all six core areas
- [ ] The human has reviewed and approved the spec
- [ ] Success criteria are specific and testable
- [ ] Boundaries (Always/Ask First/Never) are defined
- [ ] The spec is saved to a file in the repository
章节与文件索引
按说明文件中的顺序排列。
概述
何时使用
门控工作流程
第一阶段:指定
第二阶段:计划
文件/命令 -> skills/incremental-implementation/SKILL.md · incremental-implementation · skills/test-driven-development/SKILL.md · test-driven-development · skills/context-engineering/SKILL.md · context-engineering
内容校验值 -> 455f0d50fc2c
当前原文的自动摘译,尚未人工审校。
概述
在编写任何代码之前先编写结构化规范。规范是您和人类工程师之间共享的事实来源——它定义了我们正在构建什么、为什么以及我们如何知道它已经完成。没有规范的代码是猜测。
何时使用
开始新项目或功能 需求不明确或不完整 更改涉及多个文件或模块 您将要做出架构决策 该任务需要 30 多分钟才能实施
门控工作流程
规范驱动的开发有四个阶段。在当前阶段得到验证之前,请勿进入下一阶段。
第一阶段:指定
从高层次的愿景开始。向人类提出澄清性问题,直到需求具体化为止。立即提出假设。在编写任何规范内容之前,请列出您的假设:不要默默地填写不明确的要求。该规范的全部目的是在编写代码之前*揭露误解——假设是最危险的误解形式。编写涵盖这六个核心领域的规范文档: