mcpField
T
to-spec

to-spec

github.com/eszxcvfd开发135 次安装11 周前更新
代码仓库

关于 to-spec

to-spec 是一项 Agent 技能,可将现有对话上下文和代码库认知整理为规格说明,不会采访用户。它确定测试接缝,并将结果发布到项目问题跟踪器。

主要功能

  1. 01将上下文综合为规格说明
  2. 02检查仓库状态和领域术语
  3. 03识别测试接缝
  4. 04使用结构化规格模板
  5. 05发布并添加 ready-for-agent 标签

适用场景

  1. 01记录讨论中已确定的功能
  2. 02将代码库调研转为可执行规格
  3. 03整理实现与测试决策

安装

复制下面的命令,在终端中运行。

$npx skills add https://github.com/eszxcvfd/skills --skill to-spec

安装后在 Claude Code 中输入/to-spec确认已加载。

附带文件agents/openai.yaml

详细介绍

在开展面向仓库的工作之前,请阅读 ../../WORK-ROUTING.md。该文档是项目文档、工作泳道选择、计划归属和收尾工作的共享路由依据。

此技能会根据当前对话上下文和对代码库的了解,编写一份规格说明。不要采访用户——只需综合已有信息。

问题跟踪器和分类标签词汇应该已提供给你;如果没有,请运行 /setup-matt-pocock-skills。

流程

  1. 如果你还没有了解代码库当前状态,请先探索仓库。整份规格说明中使用项目的领域术语,并遵循你要处理领域内的任何 ADR。

  2. 梳理将用于测试此功能的接缝。优先使用现有接缝。尽可能选择最高层的接缝。如果需要新接缝,应尽可能在最高层提出。跨越代码库的接缝越少越好——理想情况下只有一个。

请与用户确认这些接缝是否符合他们的预期。

  1. 使用下方模板编写规格说明,然后将其发布到项目问题跟踪器。添加 ready-for-agent 分类标签——无需额外分类。

问题陈述

从用户的角度描述用户遇到的问题。

解决方案

从用户的角度描述问题的解决方案。

用户故事

一份篇幅较长、带编号的用户故事列表。每条用户故事应采用以下格式:

  1. 作为一名 <角色>,我希望获得一项 <功能>,以便 <收益>
1. 作为一名手机银行客户,我希望查看账户余额,以便更明智地决定如何消费

用户故事列表应尽可能详尽,涵盖功能的所有方面。

实现决策

列出已做出的实现决策。包括:

  • 将要构建或修改的模块
  • 将要修改的模块接口
  • 开发人员提供的技术说明
  • 架构决策
  • 架构变更
  • API 契约
  • 具体交互

不要包含具体文件路径或代码片段。这些内容很快就可能过时。

例外:如果原型生成的代码片段比文字描述更准确地表达了某项决策(如状态机、reducer、架构或类型结构),可将其内联到相关决策中,并简要说明它来自原型。仅保留能明确表达决策的部分——不要放入可运行的演示,只保留重要内容。

测试决策

列出已做出的测试决策,包括:

  • 优秀测试的特征说明(只测试外部行为,不测试实现细节)
  • 将要测试的模块
  • 测试先例(即代码库中类似的测试)

范围之外

说明本规格说明范围之外的事项。

补充说明

有关此功能的其他补充说明。

评论

支持 Markdown