SuperAPI AI 工具集

arcanea-technical-writing

写作与研究

查看项目

更新于 10-15 21:47

技能介绍

用途:帮助开发者写出用户真正能看懂的文档,覆盖文档、API 参考、教程和指南,核心理念是清晰、准确、有用。

主要能力:将文档划分为四类并说明各自定位——教程(学习导向,带新手动手完成一件事)、操作指南(问题导向,帮用户完成特定任务)、参考(信息导向,系统完整地描述技术细节)、解释(理解导向,说明原理与取舍)。同时给出写作原则:用清晰代替炫技、使用主动语态、使用现在时、直接称呼读者“你”。

使用方式:提供 README、API 参考和教程三种模板。README 模板包含项目名、一句话描述、快速开始、安装、基本用法、API 参考、贡献、许可证;API 参考模板包含函数签名、参数表(名称/类型/是否必填/说明)、返回值、示例、错误;教程模板包含目标、前置条件、分步骤操作、预期结果、总结与下一步。资料还列出常见错误(假设读者已有知识、缺少示例、代码过时、大段文字)以及维护与收集反馈的做法。

适用场景:编写或改进项目 README、API 文档、入门教程和操作指南。

限制:资料中未提供具体安装命令、运行方式、收费或价格信息;模板中的示例代码仅为格式示范,未标明适用版本或经过验证。