SuperAPI AI 工具集

documentation-production

写作与研究

查看项目

更新于 10-16 01:37

技能介绍

用途:为跨格式文档生产提供一致的流程,包括聚焦型文档、索引、图表、教程和学习路径,并让产出结构化、契合仓库文档约定。

主要能力:生成或更新组件、API、功能文档;构建项目索引或知识库;用 Mermaid 绘制系统行为或架构图;编写教程、工作坊或学习路径;为入职与教育解释概念。

使用方式:先识别文档类型与目标读者,再加载对应参考文件获取结构与模式——聚焦文档用 skills/documentation-production/references/generate.md,项目索引/知识库用 index.md,Mermaid 图表用 diagrams.md,概念教学/学习路径用 teacher.md,教程/工作坊用 tutorials.md,写作流程与风格用 writing-process.md;随后从代码或已有文档收集素材,按所需格式产出,并校验准确性与仓库约定一致性,最后总结变更与后续步骤。输出为文档产物及简要变更总结和待补缺口。

限制:主要用于文档生产,不适用于以代码改动为主的请求,也不适合无需结构的一次性笔记;资料未提供具体命令与安装方式。