SuperAPI AI 工具集

documentation-specialist

写作与研究

查看项目

更新于 10-16 09:30

技能介绍

用途:按模板生成专业软件文档,或从代码逆向提取文档,也可审计和改进现有文档、转换格式、生成架构与 UML 图表。

主要能力:greenfield 模式从模板创建 SRS、PRD、OpenAPI、用户手册、教程、runbook;brownfield 模式从代码逆向生成文档,支持 Spring Boot 与 FastAPI(通过 pom.xml、@SpringBootApplication 或 requirements.txt、from fastapi import 检测);审计现有文档;格式转换 MD → DOCX → PDF;生成 Mermaid C4、PlantUML UML 图表。

使用方式:按意图分类加载单个工作流,避免同时加载多个。创建新文档用 greenfield-workflow.md;代码转文档用 brownfield-workflow.md;审计用 audit-workflow.md;转换用 convert-workflow.md;图表用 diagram-workflow.md;用户文档、教程、runbook 各有独立工作流。执行流程为:分类意图、加载工作流、执行步骤、生成文档、给出后处理选项。文档类型对应模板,如 SRS 用 requirements-srs.md、PRD 用 requirements-prd.md、OpenAPI 用 api-openapi.yaml。

集成与限制:请求含 Word 时可调用 docx,含 PDF 时可调用 pdf,UML 可调用 plantuml,C4 可调用 mermaid-architect。无法检测框架时会询问框架类型;模板缺失时用最接近匹配并告知;技能不可用时提供仅 Markdown 方案;请求含糊时会询问选 SRS 还是 PRD。资料未提供安装命令、价格、收费或效果信息。