spec-workflow-guide

Polar Sponsor
爱发电 赞助
.NET 9.0

适用于中大型变更场景:在实施前需明确需求、技术设计及任务规划,尤其适用于涉及多模块协作、验收标准不清晰,或对架构要求较高的需求。

独立安装 Note

功能概述

独立安装 Note是一项面向实际任务的技能,主要用于如果此环境只安装了当前技能, 请从 CloudBase 主条目开始, 并使用已发布的 loudbase/ references/... 路径来进行兄弟技能;Cloud。

核心要点

  • 它将相关步骤、工具调用和结果整理方式集中到统一流程中,帮助使用者更快完成目标并减少重复操作。
  • 使用时应结合输入条件选择合适的执行方式,核对必要参数、依赖环境与输出内容,并按原始要求处理异常情况。
  • 该技能适合需要稳定复用相关能力的场景,可作为自动化工作流的一部分,也便于后续检查、调整和扩展。

使用与执行

从功能定位来看,该技能强调把分散的操作要求整理成清晰、可复用的处理流程,使用户能够围绕既定目标快速准备输入、选择执行方式并获得结构化结果。实际使用前应先确认任务范围、数据来源、运行环境、必要权限和关键参数,再依据技能说明逐步执行;

结果检查与注意事项

若输入条件不完整,应先补齐信息或采用保守配置,避免因错误假设导致结果偏离需求。执行过程中需要关注工具调用是否成功、接口或依赖是否可用、输出格式是否符合预期,并对异常提示、缺失字段和边界情况进行处理;涉及批量任务时,还应保存进度,避免中断后重复操作。

独立安装说明

若当前环境仅安装了本技能,请从 CloudBase 主入口启动,并对同级技能使用已发布的 cloudbase/references/... 路径。

  • CloudBase 主入口:https://cnb.cool/tencent/cloud/cloudbase/cloudbase-skills/-/git/raw/main/skills/cloudbase/SKILL.md
  • 当前技能原始源文件:https://cnb.cool/tencent/cloud/cloudbase/cloudbase-skills/-/git/raw/main/skills/cloudbase/references/spec-workflow/SKILL.md

对于随当前技能目录一同发布的文件,保留本地 references/... 路径。当本文件引用了同级技能(例如 auth-tool 或 web-development)时,请使用该引用旁标注的独立回退 URL。

Spec Workflow

激活契约

首次使用此流程的适用场景

  • 请求涉及新功能、多步骤产品变更、跨模块集成,或架构/设计类任务。
  • 验收标准尚不明确,需在实施前明确定义。
  • 工作涉及多个文件、用户流程、数据库设计或 UI 设计,且需分阶段确认。

编码前请先阅读(如符合以下任一情况)

  • 不确定该任务应直接进入编码阶段,还是应先完成需求分析、设计与任务规划。
  • 请求中提及新建页面、新建系统、重构设计、工作流定义,或多模块重构。

还需同步阅读

  • 前端页面或视觉设计相关工作 → ../ui-design/SKILL.md(独立回退 URL:https://cnb.cool/tencent/cloud/cloudbase/cloudbase-skills/-/git/raw/main/skills/cloudbase/references/ui-design/SKILL.md)
  • 高级数据模型相关工作 → ../data-model-creation/SKILL.md(独立回退 URL:https://cnb.cool/tencent/cloud/cloudbase/cloudbase-skills/-/git/raw/main/skills/cloudbase/references/data-model-creation/SKILL.md)

不适用于以下情形

  • 范围明确的小型缺陷修复。
  • 单文件文档更新。
  • 直截了当的配置修改。
  • 用户已给出精确实现指令的微小重构。

常见错误 / 注意事项

  • 未明确验收标准即开始编码。
  • 在需求、设计与任务各阶段之间跳过用户确认环节。
  • 编写含糊不清的任务项,无法映射到用户可感知的结果。
  • 将 UI 工作视为纯技术实现,未事先澄清设计意图。

最小化检查清单

  • 判断变更是否确实需要完整的 spec 流程。
  • 如需,则暂停并优先产出需求文档。
  • 若变更规模小、风险低,且验收标准已足够清晰,允许跳过 spec 文档,直接执行。
  • 采用 EARS 风格编写验收标准。
  • 进入下一阶段前,须获得用户确认。

何时使用本技能

当需要结构化开发时,请使用本工作流:

  • 定义或细化新功能
  • 设计复杂架构
  • 协调跨模块的变更
  • 规划数据库或 UI 密集型工作
  • 提升需求质量与验收边界清晰度

决策规则

应启用完整工作流的情形

  • 任务规模为中等或大型
  • 影响范围覆盖多个模块
  • 验收边界模糊
  • 用户明确要求在实施前进行严谨的规划

可跳过完整工作流的情形

  • 任务规模小、风险低,且已具备明确性
  • 目标、范围与验收标准已足够清晰,可直接执行
  • 用户明确要求跳过规划阶段,直接进行代码变更

核心工作流

第一阶段:需求分析

创建 specs//requirements.md。

需完成内容:

  • 重述问题与范围
  • 撰写用户故事
  • 按 EARS 风格撰写验收标准
  • 厘清业务规则、约束条件及非目标项

EARS 模式:

While <可选前置条件>, when <可选触发事件>, the <系统名称> shall <系统响应>

示例:

When the user submits the form, the booking system shall validate required fields before creating the record.

第二阶段:设计

创建 specs//design.md。

需完成内容:

  • 描述架构与模块边界
  • 说明技术选型及其权衡考量
  • 按需定义数据模型、API、安全与测试策略
  • 仅当图表能显著提升理解清晰度时,才使用 Mermaid 绘制

第三阶段:任务分解

创建 specs//tasks.md。

需完成内容:

  • 将设计方案拆解为可执行任务
  • 确保任务具体、可评审
  • 为每项任务关联对应的需求条目
  • 随工作进展实时更新任务状态

任务格式示例:

# Implementation Plan

- [ ] 1. Task title
  - Specific work item
  - Another concrete step
  - _Requirement: 1

第四阶段:执行

仅在用户确认任务计划后,方可启动实施。

执行过程中需遵守:

  • 持续更新任务状态
  • 每次完成一个具有实际意义的单元
  • 保持“变更 → 任务 → 需求”的可追溯性

代理(Agent)工作准则

  1. 当请求描述不充分时,主动提出追问;不得擅自猜测核心产品行为。
  2. 必须在需求、设计与任务分解各阶段之间获取用户确认。
  3. 若变更涉及终端用户页面或视觉决策,应尽早引入 ui-design 技能。
  4. 文档应简洁,但内容须可验证、可测试。
  5. 任务命名应优先体现用户可感知的结果,而非实现细节。

输出预期

  • requirements.md → 问题描述、范围界定、用户故事、EARS 验收标准
  • design.md → 架构设计、技术方案、数据/API/安全/测试相关说明
  • tasks.md → 关联需求的可操作实施清单

相关专题

更多
Postman身份认证怎么配置
Postman身份认证怎么配置

本专题从实际API接口调试场景出发,讲解Postman身份认证的完整配置流程,包括常见认证协议介绍、授权参数设置、访问令牌填写、OAuth 2.0授权及认证失败排查,帮助用户正确完成接口授权与访问验证。

2026.11.06

0

12

Postman请求头Headers怎么设置
Postman请求头Headers怎么设置

围绕Postman HTTP请求头配置展开,讲解Headers选项的具体使用方式,包括Key和Value参数填写、请求头信息添加、常见Header字段设置及请求头修改方法,帮助用户解决接口调试过程中遇到的请求头配置问题。

2026.11.06

0

13

Postman接口请求发送教程
Postman接口请求发送教程

详细介绍Postman接口请求的创建与发送方法,涵盖GET和POST请求、URL配置、请求参数、Headers请求头、Body请求体设置以及响应结果查看,帮助用户掌握Postman接口请求的完整操作流程。

2026.11.06

0

10

DBeaver怎么导入数据
DBeaver怎么导入数据

DBeaver数据导入专题,整理Excel、CSV、SQL、TXT等常见文件的数据导入方法,涵盖目标数据库选择、数据表创建、字段映射、数据类型设置及导入参数配置等操作,帮助用户将本地文件中的数据写入数据库,并了解批量导入、重复数据处理和导入失败等常见问题的解决方法。

2026.11.05

0

12

DBeaver安全防护教程大全
DBeaver安全防护教程大全

DBeaver安全防护专题,围绕数据库连接安全、账号密码保护和访问权限管理展开,整理SSL/TLS加密连接、SSH隧道、数据库凭据保存及证书验证等配置方法,同时介绍敏感信息保护、远程连接风险和高权限账号使用等注意事项,帮助用户提高数据库日常管理的安全性。

2026.11.05

0

12

DBeaver连接创建与配置教程
DBeaver连接创建与配置教程

本专题聚焦DBeaver数据库连接配置与管理,覆盖从新建连接、选择数据库类型到填写连接参数和验证连接的完整流程。针对MySQL、PostgreSQL、SQL Server等常见数据库,整理相应的连接设置方法,并提供驱动缺失、认证失败和连接异常等问题的排查方向。

2026.11.04

0

16

XORM框架结构体映射与表结构同步
XORM框架结构体映射与表结构同步

本专题围绕XORM框架的结构体映射展开,说明表名与字段的命名策略、xorm标签常用属性、主键自增与时间字段自动填充,并演示Sync2自动建表、增量字段升级、索引声明与反向生成结构体的完整流程。

2026.11.04

0

15

XORM框架安装配置与数据库连接
XORM框架安装配置与数据库连接

本专题聚焦XORM框架的配置与连接环节,拆解MySQL、PostgreSQL、SQLite、SQL Server的DSN写法与驱动选择,讲清连接池参数、多数据源拆分、读写分离与超时重连的处理方式,并补充容器与兼容数据库的适配经验。

2026.11.04

0

15

XORM框架安装配置与数据库连接
XORM框架安装配置与数据库连接

本专题聚焦XORM框架的配置与连接环节,拆解MySQL、PostgreSQL、SQLite、SQL Server的DSN写法与驱动选择,讲清连接池参数、多数据源拆分、读写分离与超时重连的处理方式,并补充容器与兼容数据库的适配经验。

2026.11.04

0

16

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
热门推荐
/
最新课程
phpStudy极速入门视频教程
phpStudy极速入门视频教程

共6课时 | 54.7万人学习

独孤九贱(4)_PHP视频教程
独孤九贱(4)_PHP视频教程

共89课时 | 134.1万人学习