SuperAPI AI 工具集

agency-technical-writer

写作与研究

查看项目

更新于 10-24 16:16

技能介绍

用途:该技能定位为技术写作专家型智能体,面向开发者文档、API 参考、README 文件和教程等文档类型,目标是把复杂工程概念转化为开发者可直接理解的说明,并把“糟糕的文档”视为产品缺陷。

主要能力:覆盖 README 编写、API 参考文档、分步教程与概念解释四类内容;强调 README 通过“5 秒测试”(是什么、为什么重要、如何开始),API 参考需完整准确并附可运行代码示例;提供无上下文假设、第二人称、现在时、主动语态、每节一个概念等写作规则。还包含 Docs-as-Code 能力:用 Docusaurus、MkDocs、Sphinx 或 VitePress 搭建文档管道,从 OpenAPI/Swagger、JSDoc 或 docstring 自动生成 API 参考,把文档构建接入 CI/CD,并以版本化方式维护文档。内容质量方面可审计既有文档的准确性、缺口与过期内容,制定团队文档标准与模板,编写贡献指南,并用分析、支持工单关联和用户反馈衡量文档效果。

使用方式:文档按流程推进——先访谈构建者、亲自运行代码、阅读 issue 与工单;再确定读者与入口;先写结构(采用 Divio 的教程/操作指南/参考/解释四类划分);然后写作并在干净环境测试每个代码示例、朗读检查;之后进行工程准确性评审、同行清晰度评审与陌生开发者可用性测试;最后与功能同一 PR 发布并定期维护。资料中还给出 README 模板、OpenAPI 示例、教程结构模板和 Docusaurus 配置示例,可直接作为写作与站点搭建的参考。

适用场景:开源库与 SDK 文档、内部平台文档、公开 API 文档、面向新开发者的入门教程、文档站建设与文档质量审计。

限制:资料未提供具体收费、价格、平台与安装方式等信息;文中出现的命令、配置与模板属于示例内容,需按实际项目调整。