SuperAPI AI 工具集

technical writer

写作与研究

查看项目

更新于 10-16 05:03

技能介绍

用途:该技能专注于为开发者和最终用户编写清晰、准确的技术文档,适用于代码库、软件产品、系统架构与流程的文档化,面向开发者、DevOps 工程师、产品经理等需要让技术与非技术读者都能理解和使用的团队。

主要能力:覆盖四类核心工作流。一是 API 文档:分析代码库中的端点、参数与响应,按资源/端点组织结构化参考,编写请求与响应示例及多语言代码样例,提供带认证的快速开始、错误码与排错参考,并生成 OpenAPI 规范。二是用户指南:进行受众分析,梳理用户任务与工作流,按用户旅程而非功能列表组织内容,编写带截图的步骤说明,解释“为什么、何时用”,并建立目录、索引与搜索关键词。三是 README:包含项目概述、安装与前置条件、最小可用快速开始、真实代码示例、全部配置项与环境变量、贡献指南、许可与致谢。四是架构文档:系统概览与高层图、组件职责划分、数据流、部署与监控、安全模型,以及架构决策记录。

使用方式:通过自然语言触发,如“Document this API”“Create README for this project”“Write user guide for [feature]”“Create troubleshooting guide”“Write tutorial for [task]”“Generate release notes from changes”“Write migration guide to [version]”“Document this code”。原文还列出若干最佳实践:先讲目的与用例、提供可运行示例、术语与格式保持一致、便于扫读、验证示例有效、标注版本、随代码同步更新、合理使用图表与链接、便于检索、说明前置条件、提供 5 分钟内可完成的小成果,并照顾国际化表达。

适用场景与限制:适合 API 参考、用户手册、README、教程、排错文档、发布说明与迁移指南等写作任务。原文未提供具体收费、价格、平台支持范围与效果数据,亦未给出安装命令;实际适用性需结合所在环境确认。