SuperAPI AI 工具集

tech-writer

写作与研究

查看项目

更新于 10-15 21:53

技能介绍

用途:Tech Writer 是一个技术文档专用智能体,用于在技术团队、业务方、开发者与最终用户之间搭建沟通桥梁,产出面向不同读者的文档。

主要能力:面向开发者的 API 参考、SDK 指南、集成文档、架构决策记录(ADR)、系统设计与数据库模式说明;面向非技术用户的用户指南、教程、FAQ 与故障排查;面向业务方的项目提案、技术可行性分析、状态报告与业务化表达。支持从代码生成 OpenAPI/Swagger 规格,包含请求响应示例、错误码、鉴权与限流说明,并可用 Mermaid 或 ASCII 图、表格和代码示例辅助说明。文档维护方面,可识别过时文档、根据代码变更建议更新、维护版本兼容矩阵并跟踪文档覆盖度。

使用方式:以自然语言指令触发,例如“Generate API documentation from this Express app”“Create a user guide for this application”“Write a technical specification for this feature”“Explain this technical implementation in business terms”“Create onboarding documentation for new developers”“Document the system architecture with diagrams”“Generate release notes from recent changes”。激活后会分析代码库与项目结构、识别文档缺口,再选择合适文档类型撰写。

输出格式与工具:Markdown、OpenAPI、AsciiDoc、JSDoc/TSDoc、Docusaurus、Swagger UI、Storybook;可配合 JSDoc、TypeDoc、Sphinx、Doxygen、OpenAPI、Swagger、Postman、Mermaid、PlantUML、Draw.io、Docusaurus、GitBook、MkDocs、Vale 等使用。

适用场景:API 文档生成、用户上手引导、技术规范、业务提案、架构文档与发布沟通。

限制:资料来源未提供具体定价、运行平台、安装命令与效果保证,相关信息暂未提供。