mcpField
T
to-spec

to-spec

github.com/timschoch开发0750 次安装3 天前更新
代码仓库

关于 to-spec

to-spec 是一项将对话上下文和代码库理解整理为功能规格的技能,并将其发布到配置的议题跟踪器。它涵盖代码库审查、测试接缝选择和议题标记,不要求访谈用户。

主要功能

  1. 01根据现有上下文综合规格
  2. 02审查代码库状态和领域规范
  3. 03识别并确认测试接缝
  4. 04使用结构化规格模板
  5. 05发布并应用分流标签

适用场景

  1. 01记录对话中讨论的功能
  2. 02编写遵循项目 ADR 的规格
  3. 03发布供 Agent 实施的规格

安装

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

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

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

附带文件agents/openai.yaml

详细介绍

此技能会结合当前对话上下文和对代码库的理解来编写规格说明。不要采访用户;只需综合已有信息。

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

流程

  1. 如果你还不了解代码库的当前状态,请探索代码库。全程在规格说明中使用项目的领域词汇,并遵循你要修改部分的 ADR。

  2. 勾勒出测试此功能的切入点。优先使用现有切入点,并尽可能选择最高层级的切入点。如果需要新增切入点,请在你能做到的最高层级提出。跨越整个代码库的切入点越少越好,理想情况下只有一个。

与用户确认这些切入点是否符合他们的预期。

  1. 使用以下模板编写规格说明,然后将其发布到项目的问题跟踪器。应用 ready-for-agent 分类标签;无需进一步分类。

    如果此规格说明细化了一个现有父级问题(例如,对话从史诗级问题开始,或用户提供了该问题的引用),请按照问题跟踪器文档中的操作方式,将已发布的规格说明作为原生子问题关联到该父级问题,使其显示在父级问题的子问题列表中,而不只是出现在正文中。

<规格说明模板>

问题陈述

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

解决方案

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

用户故事

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

  1. 作为一名<角色>,我希望<功能>,以便<收益>

<用户故事示例>

  1. 作为一名移动银行客户,我希望查看自己账户的余额,以便更全面地了解自己的消费情况 </用户故事示例>

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

实现决策

列出已做出的实现决策。内容可以包括:

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

不要包含具体文件路径或代码片段,因为它们很快就可能过时。

例外:如果原型生成的代码片段比文字更能准确表达某项决策(如状态机、reducer、架构或类型定义),可将其内嵌到相关决策中,并简要说明该片段来自原型。只保留体现决策的关键部分,不要放入可运行的示例,只需包含重要内容。

测试决策

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

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

不在范围内

说明本规格说明中不包含哪些内容。

补充说明

有关此功能的其他说明。

</规格说明模板>

评论

支持 Markdown