SuperAPI AI 工具集

tech-review-doc

写作与研究

查看项目

更新于 10-16 05:47

技能介绍

用途:把代码密集的技术设计文档转成面向产品、QA 及非深度接触代码的工程师的技术评审文档,输出为 Markdown 文件。

主要能力:§1–§3 不含代码(仅 Mermaid 图);§4 起只保留必要的接口、字段、表用途说明;图使用业务/模块名而非类名或文件名;设计文档为事实来源,用户确认内容优先于模糊表述;每节自问评审会是否有人需要,不需要则省略。

使用方式:输入设计文档路径(必填,可用 @ 或路径),可选评审类型(方案/实现/验收评审,默认方案评审)。开始前完整阅读设计文档,必要时扫描相关 PRD 或 OpenSpec 变更;超过约 1500 行先浏览结构与标题再按需深读。输出写到输入文档旁,命名 tech-review-{topic}-{YYYY-MM-DD}.md,topic 取自设计标题关键词,日期用当前日期。

流程为五步硬门:Step 0 启动检查;Step 1 背景与目标(澄清,用户明确批准 §1 前不写文件);Step 2 生成 §2 必要图;Step 3 多方案对比 → §3(无则跳过);Step 4 核心内容摘要 → §4;Step 5 完成 §§5–7 并写文件。加载时需检查 clarifying-question-discipline 是否可用,缺失则中止并打印:npx skills add FuDesign2008/open-skills -g --skill clarifying-question-discipline --yes,不得静默回退。

适用场景:方案评审、实现评审、验收评审前的文档转换,尤其适合需要产品与 QA 独立读懂前四节的评审会。

限制:§1 必须经用户明确确认才能继续;§3、§6 按条件生成或跳过;§4 不得成为代码堆砌;写完后需删除模板末尾“模板使用说明”;在聊天中报告输出路径、§1 是否确认、生成了哪些图、§3/§6 是否跳过及遗留占位符。自动模式下 §1 硬门仍生效,批准后 Steps 2–5 可连续执行。