SuperAPI AI 工具集

to-prd

写作与研究

查看项目

更新于 10-18 16:13

技能介绍

用途\n该技能用于将当前对话上下文与对代码库的理解综合成一份 PRD,而不是通过访谈收集需求。默认输出为本地 Markdown,用户明确要求时可发布到 GitHub 或 GitLab。\n\n主要能力\n- 综合对话与代码库现状生成 PRD。\n- 默认发布到本地 .scratch/<feature-slug>/PRD.md,无需远程仓库。\n- 支持发布为 GitHub issue(gh CLI)或 GitLab issue(glab CLI),仅在用户明确要求时使用。\n- 在 PRD 中统一使用项目领域词汇,并遵循相关 ADR。\n- 规划测试接缝:优先使用已有接缝、选择尽可能高的接缝,新接缝也应尽量位于高层,接缝数量越少越好。\n- 编写包含问题陈述、解决方案、长列表用户故事、实施决策、测试决策、范围外和备注的 PRD。\n- 发布时应用 ready-for-agent 分诊标签;本地 Markdown 则以文件顶部 Status: ready-for-agent 行记录。\n\n使用方式\n1. 选择发布位置:默认本地 Markdown;GitHub 或 GitLab 仅在用户明确要求时使用,不要主动探测 git remote。\n2. 如尚未了解代码库,先探索仓库现状;使用项目领域词汇并遵守相关 ADR。\n3. 勾画测试接缝并与用户确认是否符合预期。\n4. 按模板撰写 PRD 并发布:GitHub 使用 gh issue create 带标题、正文与标签;GitLab 使用 glab issue create 带标题、描述与标签;本地则写入 .scratch/<feature-slug>/PRD.md 并创建目录。\n5. 若使用 GitHub 或 GitLab,且 docs/agents/issue-tracker.md 覆盖该后端,则遵循其中的约定与分诊标签映射;否则使用技能中给出的目的端约定。可通过 /setup-skills 配置约定与分诊标签词汇。\n\nPRD 模板包含:问题陈述(从用户视角)、解决方案(从用户视角)、长篇编号用户故事(格式为 As a , I want a , so that )、实施决策(模块、接口、技术澄清、架构决策、Schema 变更、API 契约、具体交互;不写具体文件路径或代码片段,原型片段仅在能更精确表达决策时内联并注明来源)、测试决策(好测试的标准、被测模块、同类测试先例)、范围外、进一步备注。\n\n适用场景\n适合在已有充分对话与代码库理解的上下文中快速沉淀 PRD;适合需要将讨论结果转为可执行需求文档并进入后续代理处理的团队。\n\n限制\n不进行用户访谈;默认仅生成本地 Markdown,GitHub/GitLab 发布需显式请求;不提供具体文件路径或代码片段(原型决策片段除外);远程发布依赖 gh 或 glab CLI 及相应配置;分诊标签映射依赖 docs/agents/issue-tracker.md 或 /setup-skills 配置。其他细节暂未提供。