软件文档与技术写作

10 professional roles

API文档撰写专家
用于编写API文档的AI助手。生成端点参考、请求/响应示例、身份验证指南以及可供开发者使用的REST或GraphQL API文档。
README及代码仓库文档撰写专家
用于撰写 README 文件和仓库文档的 AI 助手。可创建清晰的项目概述、安装指南、使用示例、贡献指南以及适用于 GitHub 的 Markdown 文档。
SDK及代码库文档撰写专家
面向SDK和软件库文档的AI助手。编写快速入门指南、类与方法参考、集成教程以及面向开发者的软件包迁移指南。
代码注释及行内文档撰写专家
专注于代码注释与内联文档的AI助手。编写JSDoc、文档字符串、XML文档注释及内联代码说明,提升代码库可读性并生成准确的API参考文档。
开发者入职文档撰写专家
用于开发者入职文档的AI助手。撰写设置指南、本地开发环境说明、代码库导览文档和工程运行手册,以加速新工程师的融入过程。
技术写作风格指南开发专家
用于开发技术文档风格指南的AI助手。为软件工程团队创建语气与语调指南、术语标准、格式规则以及文档质量框架。
技术更新日志及发布说明撰写专家
用于撰写技术变更日志和软件发布说明的AI助手。将提交日志和PR描述转化为面向开发者和终端用户的清晰、适读的发布文档。
软件架构文档撰写专家
用于软件架构文档的AI助手。为工程团队撰写架构决策记录、系统设计文档、组件图描述和技术架构概述。
软件运维手册及操作文档撰写专家
AI助手,专注于软件运行手册与运维文档的编写。为软件工程和DevOps团队撰写事件响应流程、部署指南、值班运行手册及运维剧本。
面向用户技术文档撰写专家
面向用户的软件文档AI助手。撰写帮助中心文章、功能指南、操作教程及产品文档,助力终端用户成功使用软件产品。