【Kiro】 规格文档概念(Concepts)
Concepts(概念)
Specs(规格文档)连接了产品概念需求与技术实现细节之间的鸿沟,确保产品与工程保持一致,减少开发反复。Kiro 会自动生成三个关键文件,这些文件构成了每个 specification(规格文档)的基础:
requirements.md - 使用结构化的 EARS(Easy Approach to Requirements Syntax)格式记录 user stories(用户故事)和 acceptance criteria(验收标准)
design.md - 用于记录技术架构、sequence diagrams(时序图)以及实现相关的技术考虑
tasks.md - 提供详细的实施计划,包含可追踪的离散任务
Workflow(工作流程)
整个工作流程按照逻辑顺序推进,在各个阶段之间设有决策点,确保每一步在进入下一阶段之前都已妥善完成。
Requirements Phase(需求阶段)(最左侧部分):用结构化的 EARS 格式定义 user stories 和 acceptance criteria
Design Phase(设计阶段)(第二部分):记录技术架构、sequence diagrams 以及实现细节
Implementation Planning(实施计划阶段)(第三部分):将任务拆分为清晰、可追踪的离散任务,并附有明确的说明与预期结果
Execution Phase(执行阶段)(最右侧部分):在任务完成过程中跟踪进度,支持根据需要更新和完善 spec
Requirements(需求)
requirements.md
文件以 EARS 格式撰写的 user stories 和验收标准的形式存在。它就像你最希望产品经理能交付的那种需求文档!
EARS(Easy Approach to Requirements Syntax)是一种结构化的需求描述方式,用于编写清晰且可测试的需求。在 specs 的 requirements.md
文件中,每一条需求都遵循以下格式:
WHEN [条件/事件] THE SYSTEM SHALL [预期行为]
例如:
(当用户提交包含无效数据的表单时,系统应在相关字段旁显示验证错误)
这种结构化方法带来了以下好处:
清晰性(Clarity):需求表达明确、易于理解
可测试性(Testability):每一条需求都能直接转化为测试用例
可追踪性(Traceability):每条需求都可以贯穿整个开发过程进行追踪
完整性(Completeness):这种格式鼓励全面思考各种条件与行为
Kiro 能帮你将模糊的功能请求转化为结构良好的需求,使开发流程更高效,减少产品与工程团队之间的误解。
Design(设计)
design.md
文件用于记录技术架构、sequence diagrams 和实现相关的技术考量。这个文档能帮助你勾勒系统整体的运行方式,包括组件及其交互方式。
Kiro 的 specs 提供了结构化的设计文档格式,让你更容易理解和协作复杂系统。在 design.md
文件中,你可以很好地捕捉系统整体架构图景,包括组件和它们之间的交互。
Implementation plan(实施计划)
tasks.md
文件用于撰写详细的实施计划,列出清晰、可追踪的任务及其子任务。每个任务都具有明确的说明、预期结果,以及所需的资源或依赖项。Kiro 的 specs 提供结构化的任务规划方式,能帮助你更清楚地理解并协作处理复杂系统的开发。
Kiro 还为 tasks.md
文件提供任务执行界面,可以实时显示任务的状态更新。任务完成进度会被标记为进行中或已完成,帮助你高效地跟踪开发进度,随时掌握项目的最新状态。