SuperAPI AI 工具集

managing-product-specifications

写作与研究

查看项目

更新于 10-16 04:22

技能介绍

用途

管理产品规格(Managing Product Specifications)是一个用于预实现阶段产品规格文档的技能集合,专门处理磁盘上的产品规格 Markdown 文件。它适用于所有智能体能够读取和写入仓库文件的环境。

该技能覆盖的产品规格文档包括:PRD(产品需求文档)、FRD(功能需求文档)、TRD(技术需求文档)、用户故事(user story)以及 UI 规格(UI specs)。这些文档可以位于产品级别(<docs-root>/)或功能级别(<docs-root>/features/<slug>/)。

主要能力

  • 创建、更新和审查产品规格 Markdown 文档,保持结构、frontmatter 和组织方式的一致性。
  • 支持产品级与功能级两个层级的规格管理。
  • 通过契约文件规定文档布局、命名、frontmatter、继承关系和层级。
  • 通过配方(Recipes)表,将文档类型与操作(创建/更新/审查)映射到具体的参考文件。
  • 产品伴随文档(如 <docs-root>/trd-web.md)与功能伴随文档(如 <docs-root>/features/<slug>/trd-api.md)使用相同的配方。
  • 提供模板资源(assets)用于生成标准文档。

使用方式

该技能以智能体工作流的形式运行。当需要创建、更新或审查产品规格 Markdown 时,遵循以下要点:

  1. 确定文档根目录(Docs root):仅通过带有 frontmatter 中静态 Author 签名 UUID 的 <docs-root>/index.md 来定位。如果不存在,则询问用户一个空文件夹路径,并在任何规格操作之前用 index.md 初始化。具体规则参见 spec-contract.md → Resolve docs root。
  2. 匹配配方:根据文档类型和操作类型匹配一个 Recipes 表格单元,并准确打开对应的参考文件。例如:
    • PRD 创建对应 creating-prd.md,更新对应 updating-prd.md,审查对应 reviewing-prd.md;
    • FRD 创建对应 creating-frd.md,更新对应 updating-frd.md,审查对应 reviewing-frd.md;
    • TRD 创建对应 creating-trd.md,更新对应 updating-trd.md,审查对应 reviewing-trd.md;
    • 用户故事创建对应 creating-user-story.md,更新对应 updating-user-story.md,审查对应 reviewing-user-story.md;
    • UI 规格创建对应 creating-ui-specs.md,更新对应 updating-ui-specs.md,审查对应 reviewing-ui-specs.md。
  3. 路径解析:产品伴随文档与功能伴随文档使用相同配方;<docs-root> 来源于 spec-contract.md → Finding docs root。
  4. 不涉及应用代码:除非用户在同一条消息中明确要求,否则停止,不编写应用代码。

适用场景

  • 在产品实现之前编写或整理产品需求文档、功能需求文档与技术需求文档。
  • 维护功能级别的规格,例如 features/<slug>/ 下的 frd.md 中心文档。
  • 需要以只读方式审查现有规格文档时(reviewing-* 类参考)。
  • 在 monorepo 中通过伴随文档(如 trd-web.md、trd-api.md)管理不同应用的技术规格。
  • 需要统一 frontmatter、命名与继承结构的产品文档体系。

参考与模板

参考索引包括:

  • 契约:spec-contract.md,涵盖文档根 index.md 标记、作者 UUID、路径、命名、frontmatter、继承与层级。
  • 创建类:creating-prd.md(新建 prd.md)、creating-frd.md(新建 features/<slug>/frd.md 中心)、creating-trd.md(新建产品级或功能级 TRD,trd.md、trd-<app>.md)、creating-user-story.md(新建产品或功能用户故事)、creating-ui-specs.md(新建产品或功能 UI 规格)。
  • 更新类:updating-prd.md(修改 prd.md 并同步功能索引)、updating-frd.md(修改 FRD 并同步相关文档与 PRD 索引)、updating-trd.md(修改 TRD 并标记下游漂移)、updating-user-story.md(修改用户故事)、updating-ui-specs.md(修改 UI 规格)。
  • 审查类:reviewing-prd.md、reviewing-frd.md、reviewing-trd.md、reviewing-user-story.md、reviewing-ui-specs.md,均为只读审查。

模板资源(assets)包括:index.md、prd.md、frd.md、trd.md、user-story.md、ui-specs.md。

限制

该技能不涉及应用代码的实现,除非用户在同一消息中明确要求。文档根目录的定位依赖带有特定作者签名 UUID 的 index.md;若不存在,需先由用户提供空文件夹路径并初始化。资料未提供关于收费、价格、平台兼容性、具体效果或性能的说明,暂未提供。