SuperAPI AI 工具集

to-spec

编程与开发

查看项目

更新于 10-16 02:33

技能介绍

用途:把当前对话上下文与对代码库的理解综合成一份规格说明(spec),并发布到项目的问题跟踪器。该技能明确要求不要访谈用户,只综合已知信息。

前置条件:问题跟踪器与 triage 标签词表应已提供;若未提供,需提示用户运行 /setup-agent-skills。

主要流程:先探索仓库以了解代码库现状;在 spec 中沿用项目领域术语表词汇,并遵守相关区域的 ADR。随后勾勒测试该功能的接缝(seam),优先复用已有接缝,使用尽可能高的接缝;若需新接缝,在尽可能高的位置提出,接缝越少越好,理想数量为一个。与用户确认这些接缝符合预期后,按模板撰写 spec 并发布到问题跟踪器,打上 ready-for-agent 标签,无需额外 triage。

spec 模板包含:问题陈述(从用户视角描述用户面临的问题)、解决方案(从用户视角描述)、用户故事(很长的编号列表,格式为“作为……,我想要……,以便……”)、实现决策(涉及构建/修改的模块及其接口、技术澄清、架构决策、schema 变更、API 契约、具体交互;不要包含具体文件路径或代码片段,除非原型片段比文字更精确地编码了某项决策,此时可内联并注明来自原型)、测试决策(好测试的标准是只测外部行为而非实现细节、将测试哪些模块、测试的既有先例)、范围外内容、进一步说明。

限制:资料未提供具体安装命令、收费或平台信息。