SuperAPI AI 工具集

tech-design-doc

编程与开发

查看项目

更新于 10-15 20:05

技能介绍

用途:该技能用于生成技术设计文档,适合设计新功能或记录架构。

执行流程:先评估复杂度。小型(单组件、<100 行代码)只需 TL;DR、设计与实现;中型(跨组件、涉及 API 变更)再加背景与方案分析;大型(系统级、新服务)使用完整模板。随后收集上下文:用 Glob 和 Grep 查找相关代码,识别受影响组件,阅读现有实现与模式,记录依赖与潜在副作用,并检查代码库中是否已有类似方案。

撰写阶段:从 $SKILL_DIR/references/TEMPLATE.md 读取模板,按模板结构并根据复杂度缩放后撰写文档。交付前需核验:是否清晰定义问题(不做会破坏什么)、是否比较多个方案及取舍(不可只给一个方案)、是否记录决策理由、是否用图表说明关键流程、实现步骤是否具体可执行、是否识别风险并给出缓解措施。

处理反馈:定位需修改的章节,仅更新受影响部分,确保改动不与其他章节矛盾,并重新核验相关检查项。

输出位置:优先查找项目中的 docs/、ai_docs/ 或 design/ 目录;位置不明确时询问用户。文件名应具描述性,例如 design-[feature-name].md。

限制:官方资料未提供更多模型、平台或收费信息。