openspec
一个设计驱动开发框架 帮助开发者整理需求-设计方案-实施 每次变更作为一次记录,可持久化到文件目录作为之后工作的上下文
安装
C:\Users\cenhuiyingcursor\skills\openspec-setup\SKILL.md
skill说明:
用于OpenSpec全局安装配置。
保证使用者在任何目录使用该skill之后
1.全局安装,在(默认codx)codx/cursor/其他ide平台,任何项目目录都可以使用
2.对于openspec的斜杠命令,安装结束之后给简单的例子+语句说明全流程(中文)
3.没有npm会帮忙下node
4.如果有下载过,检查openspec更新
基本工作流程
按照语句实施顺序说明openspec的工作流。IDE里有两套斜杠命令可用:/openspec-* 和 /opsx-*,内容一样,混用无影响(见文末说明)。
1./openspec-explore
说明:探索模式,可以选择运行(如果方案/需求足够清晰,可以跳过这一步)
主要是探索模糊想法/需求,最后不会生成文件或者变更,相当于比较规范化的聊天,如果聊出来的结果足够清晰,会建议用户下次直接输出/opsx-propose进行第二步。
创建的文件有哪些:无,不创建文件。
格式:/openspec-explore 【模糊需求/想法等;可以不用打方框】
2./openspec-propose
说明:运行之后,设计构思方案,形成设计的架构文件夹/change。
(ps:该文件夹下的子文件夹结构差不多每次都一样,可能根据需求有个数上的差别;每次propose就创建一次,生成方案规范任务文档,等任务实施结束,按需选择是否归档。归档的时候,整个change文件夹会加上时间,转移到/archive目录下。所以可以在/archive文件夹下看历史变更,也会有个文档统一介绍变更记录和结果。做到持久化)
创建的文件有哪些:
openspec.yaml(配置文件,记录日期,可以不用管)
proposal.md(全局决策文件):why(为什么做)、what changes(变更有什么)、capabilities(如果要达成需求,要完成的功能们)、impact(列表:预计新增的文件、需要改的文件、要做持久化的文件、项目级文件。会做一个相对路径索引,也相当于初步构建文件架构了)
design.md(约束决策风险文件):相当于给proposal文件提到的全局方案提出兜底。约束和决策让后续任务不偏离目标,风险让后续任务避坑。
/spec/*(按照需求有不同子文件夹)/spec.md(每个需求对应一个仔细方案)(记录仔细的需求、方案、验收条件):【按照需求有不同子文件夹】这里指按照proposal全局决策文件下的capabilities(功能们),每个功能创造一个子文件夹,子文件夹下一个spec文档(spec即方案、规划),记录要完成此功能需要做的详细方案。
tasks.md(任务清单):按照方案列出步骤,说明每步的任务具体内容、产出物、预期结果。
有checkbox[](每步做完的话:[]会变成[×],标记做完了,才能进行下一步任务)
格式:/openspec-propose 【清楚的需求/或者在完成第一步探索explore之后不输出括号内容也可以】
3./opsx-apply
说明:按照第二个,即propose阶段生成的任务tasks文档进行开发。
有下面这些运行原则:
逐条做tasks,做完才可做下一条;
若任务不清楚,ai可询问开发者;
实施时发现任务有问题,就暂停问开发者是否要修改,然后更新第二步生成过的约束文件和仔细方案文件,即design、spec文档;
保持最小改动化,每步骤完成立即同步当前task进度。
创建的文件有哪些:开发过程中的项目级文件。(不在openspec目录下)
格式:/openspec-apply-change
(一般就这样 除非有特殊说明也可以加在后面)
上述运行原则保证了开发任务执行不偏离。(Guardrails,护栏原则)
4./opsx -archive
说明:归档。就是记录、持久化当前需求对应的任务以及执行情况以及日期。
可以选择是否归档、归档哪些内容,剩下的文件怎么处理。
会把当前需求在propose阶段产生的change文件夹。
主要步骤是:
用户输入命令,选择需要归档的内容;
ai检查完成状态:按照propose阶段生成的文件,检查propose、designs、spec、tasks,确认有没有偏离,有没有遗留任务等;
继续查tasks,再次校验;
评估归档的价值,告知用户,确认归档之后,转移整个change文件夹,加上日期。变更内容记录到全局
创建的文件有哪些:无
格式:/openspec-archive-change
(一般就这样 除非有特殊说明也可以加在后面)
综上是常用的语句,也是使用openspec作为设计驱动开发框架的流程:propose、apply、archive。
补充:/openspec-* 和 /opsx-* 的关系
Cursor 有两种扩展机制:Skills(文件夹形式)和 Commands(单文件形式)。OpenSpec 安装时两种都生成了,所以 IDE 里出现两套命令:
|
/openspec-*(Skill) |
/opsx-*(Command) |
|---|---|
|
/openspec-propose |
/opsx-propose |
|
/openspec-apply-change |
/opsx-apply |
|
/openspec-explore |
/opsx-explore |
|
/openspec-archive-change |
/opsx-archive |
两套都装在全局目录(~/.cursor/skills/ 和 ~/.cursor/commands/),所有项目可用,内容一样,混用无影响。

1429

被折叠的 条评论
为什么被折叠?



