SuperAPI AI 工具集

technical-documentation

写作与研究

查看项目

更新于 10-16 04:29

技能介绍

用途:根据规范、代码或需求生成专业的技术文档,并帮助改进已有文档。适用场景包括新系统设计、现有设计完善、架构评审、产品需求与敏捷故事编写、代码解释、可视化图表、PR 描述和 Git 变更总结。

主要能力与模式:create_design_document 用于系统架构与 C4 模型;refine_design_document 用于提升设计文档清晰度、补齐缺口;review_design 从可扩展性与安全性角度评估设计;create_prd 用于功能规格与产品规划;create_user_story 生成含验收标准的敏捷故事;explain_code 解释代码库、配置和工具输出;explain_docs 把技术文档改写得更清晰;create_mermaid 生成流程图、时序图与 ERD;write_pull_request 汇总代码变更;summarize_git_diff 解释提交改动。

选择方式:新系统或功能用 create_design_document 或 create_prd;已有设计待改进用 refine_design_document 或 review_design;需要解释代码用 explain_code;需要图表用 create_mermaid;敏捷产物用 create_user_story;Git 或 PR 相关工作用 write_pull_request 或 summarize_git_diff。

使用与输出:资料未提供安装命令或调用示例,具体用法暂未提供。文档输出应保持一致的标题层级(H1 标题、H2 分节),在有助于理解时加入图表(优先 Mermaid),代码块须标注语言,设计文档需覆盖安全、可扩展性和故障模式,PRD 聚焦做什么而非怎么做,实现细节留给设计文档。

可串联使用:create_prd 后可接 create_design_document,create_design_document 后可接 create_mermaid,explain_code 后可生成文档或测试,review_design 后可接 refine_design_document 处理问题。

限制:资料未说明支持的平台、收费方式、价格、效果或具体安装步骤,这些暂未提供;使用前需确认运行环境与调用方式。