mcpField
T
to-spec

to-spec

github.com/nstaab1开发049 次安装3 周前更新
代码仓库

关于 to-spec

to-spec 是一项将对话上下文和代码库理解整理为功能规格的技能,面向需要把需求发布到项目 issue tracker 的团队。它按固定模板记录用户故事、实现与测试决策,并应用 ready-for-agent 标签。

主要功能

  1. 01结合对话与代码库生成规格
  2. 02遵循领域术语和 ADR
  3. 03规划并确认测试边界
  4. 04按模板组织规格内容
  5. 05发布到 issue tracker 并标记

适用场景

  1. 01将已有讨论整理为开发规格
  2. 02明确新功能的测试边界
  3. 03记录实现决策与范围外事项
  4. 04把规格提交到项目跟踪器

安装

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

$npx skills add https://github.com/nstaab1/nathan-agent-skills --skill to-spec

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

附带文件agents/openai.yaml

详细介绍

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

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

流程

  1. 如果你尚未探索过代码库,请先了解代码库的当前状态。在整个规范中使用项目的领域词汇表,并遵循你要修改的相关领域中的任何 ADR。

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

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

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

问题陈述

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

解决方案

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

用户故事

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

  1. 作为一名 ,我希望拥有一项 ,以便
1. 作为一名手机银行客户,我希望查看账户余额,以便更充分地了解自己的消费情况

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

实施决策

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

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

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

例外:如果原型生成的代码片段比文字描述更准确地表达了某项决策(例如状态机、reducer、架构或类型形状),可将其内嵌在相关决策中,并简要注明该内容来自原型。只保留能明确表达决策的关键部分,不要保留完整演示代码。

测试决策

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

  • 良好测试的标准(只测试外部行为,不测试实现细节)
  • 将要测试的模块
  • 测试的先例(即代码库中类似类型的测试)

范围之外

描述本规范不涵盖的内容。

补充说明

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

评论

支持 Markdown