SuperAPI AI 工具集

devdocs-insights

编程与开发

查看项目

更新于 10-15 08:12

技能介绍

用途

devdocs-insights 用于收集开发过程中的改进建议,并将其转化为可追踪的开发需求。它将来自不同渠道的改进想法统一整理、确认并结构化输出,衔接需求文档与后续开发流程。

主要能力

  • 多渠道洞察收集:支持四类来源,包括 UI/UX 审查(界面问题、交互优化、视觉改进)、文档调研(技术方案、设计模式、架构参考)、外部参考(竞品分析、行业最佳实践、开源项目)、内部反馈(用户反馈、团队建议、性能监控)。
  • 结构化建议列表:对建议进行分类整理、评估影响范围、标注优先级(P0/P1/P2)。
  • 用户确认流程:通过 AskUserQuestion 进行交互式确认,支持单条确认、批量确认、调整优先级或拒绝。
  • 需求转化:将确认的建议转化为功能点(F-XXX)和验收标准(AC-XXX),新功能、优化、技术改进分别有对应转化规则;Bug 类建议触发 /devdocs-bugfix 流程。
  • 变更日志记录:在 docs/devdocs/05-insights.md 中记录 INS 编号、来源、确认时间和转化目标,避免与需求文档双写不同步。

使用方式

通过命令触发,可选模式包括:

# 标准模式:交互式收集和确认
/devdocs-insights

# 从 URL 提取建议
/devdocs-insights --url <url>

# 从文件提取(如审查报告)
/devdocs-insights --file <path>

# 快速模式:直接输入建议列表
/devdocs-insights --quick

支持中英文提问,统一中文回复,使用中文生成文档。确认建议后,可根据改进是否涉及架构变更选择后续路径:无架构变更走 /devdocs-dev-tasks 直接拆分任务;有架构变更走 /devdocs-feature 完整流程。

输出文件

  • 需求追加:docs/devdocs/01-requirements.md(唯一内容源)
  • 洞察变更日志:docs/devdocs/05-insights.md

适用场景

  • 用户完成 UI/UX 审查,有优化建议
  • 用户调研了文档或方案,发现可借鉴点
  • 用户发现外部参考(竞品、最佳实践)可借鉴
  • 用户有改进想法需要转化为需求

限制与约束

  • 收集约束:必须标明建议来源;必须评估影响范围;每条建议需有明确的现状和改进点;外部参考必须提供来源链接。
  • 确认约束:所有建议必须经用户确认才能转化;拒绝的建议必须记录原因;批量确认前必须展示完整列表;用户可调整优先级。
  • 转化约束:转化后的需求必须可追溯到原始建议;必须生成可验证的验收标准;优化类需求必须标记 [优化] 标签;转化后更新建议状态。
  • 避免需求膨胀:单次收集建议不超过 10 条;低优先级建议可标记为"待定";定期清理过期的待确认建议。