SuperAPI AI 工具集

technical-writer

写作与研究

查看项目

更新于 10-15 08:47

技能介绍

Technical Writer 是一个面向技术文档写作的技能,旨在为开发者、用户和利益相关者提供创建有效技术文档的专业能力。它专注于 API 文档、用户指南、教程,以及构建可维护、服务多样化受众的文档系统。

用途 该技能用于在需要编写技术文档时提供专业支持,覆盖从 API 参考到入门教程、从知识库到发布说明的多种文档类型,并帮助统一项目间的文档风格。

主要能力

  • API 文档:审查 API 端点与数据模型,编写清晰的端点描述与用例,记录请求/响应格式并附示例,涵盖认证与错误处理,添加多语言代码示例,测试示例准确性,并为 API 变更设置版本管理。
  • 教程开发:识别目标受众与前置条件,定义学习目标与成果,按渐进复杂度组织内容,编写带上下文的逐步说明,提供可复制运行的代码示例,包含常见问题排查,并在全新环境中测试教程流程。
  • 文档维护:建立文档审查计划,设置断链自动检查,随代码变更同步跟踪文档,收集并纳入用户反馈,在 API 变更时更新示例,妥善归档弃用内容,并监控分析数据以发现改进机会。
  • 文档类型决策:根据文档类型选择对应形式,如 API 参考采用 OpenAPI 规范加生成文档,入门指南提供快速开始与首次成功体验,概念说明提供架构概览与心智模型,操作指南采用任务导向的分步说明,故障排查采用问题-解决方案格式,发布说明采用面向用户的变更描述。

使用方式 在编写 API 文档与参考指南、创建用户指南与入门教程、构建知识库与 FAQ、编写 README 与项目文档、创建开发者入职文档、记录架构与系统设计、编写发布说明与变更日志、以及标准化跨项目文档风格时调用该技能。

不适用场景 编写代码注释属于开发者职责;创建 ADR 应使用 document-writer;编写营销内容应使用 content-marketer;设计文档基础设施应使用 documentation-engineer。

最佳实践 为读者的目标而写,而非按系统结构组织;使用一致术语并定义词汇表;包含用户可复制的工作代码示例;在干净环境中测试所有流程;保持句子简短、段落聚焦;在能提升清晰度时使用图表和截图等视觉元素。

反模式 以开发者为中心的写作应转向关注用户任务与目标;过时示例应通过自动化测试代码示例来避免;大段文字应改用标题、列表和留白;假设读者已有知识应改为明确说明前置条件;一次性写作应改为将文档视为持续更新的活文档。

限制 该技能不负责编写代码注释、ADR、营销内容或文档基础设施设计,这些任务应使用其他对应技能。