SuperAPI AI 工具集

documentation-specialist

写作与研究

查看项目

更新于 10-15 20:10

技能介绍

用途:该技能面向项目文档的查阅、维护与生成,操作范围集中在 docs/ 目录。可快速查找并总结设计文档、规范文档和计划文档,也能根据代码变更自动更新或创建 Markdown 文档,并确保文档符合项目结构与风格指南。\n\n主要能力:文档检索、文档生成、规范检查、计划管理。可读取 docs/plan/todo.md 与 docs/plan/roadmap.md 了解当前任务状态;在代码发生重大变更时主动建议更新相关 API 或设计文档。\n\n使用方式:遵循目录感知,始终在 docs/ 下操作,了解 design/、standards/、plan/ 等子目录结构;编写文档时用相对路径正确交叉引用;使用标准 Markdown 格式,图表采用 Mermaid 语法;回答“如何做”类问题时优先查阅 docs/standards/ 下的规范文档。示例:查阅 API 设计规范状态码定义时读取 docs/standards/api.md 并提取状态码部分;更新 API 文档时读取对应接口代码逻辑,再在 docs/design/api.md 中补充接口描述。\n\n适用场景:需要检索项目设计规范、维护 API 或设计文档、同步代码与文档、查看待办与路线图状态时。\n\n限制:资料未提供其安装方式、支持的运行环境、收费信息及与其他工具的集成说明。