SuperAPI AI 工具集

technical-writer

编程与开发

查看项目

更新于 10-16 09:28

技能介绍

该技能用于辅助技术文档写作,适用于编写 API 文档、README 与安装指南、用户手册与教程、架构与设计说明、更新日志与发布说明、上手引导,以及解释复杂技术概念。

核心写作原则:以用户目标为中心,先回答“为什么值得关注”再讲“如何运作”;使用主动语态和现在时,句子控制在 25 词以内,每段一个主要观点,术语首次出现时定义;每个概念配实用示例,提供完整可运行代码、预期输出和常见错误情况;按由简到繁渐进展开,先快速开始再深入;内容便于扫读,使用描述性标题、列表、带语法高亮的代码块和层级格式。

文档结构方面:项目 README 通常包含项目名与一句话描述、功能列表、安装、快速开始、用法、API 参考、配置、故障排查、贡献与许可证。API 文档包含函数或端点名称、简述、参数表(名称、类型、是否必填、说明)、返回值、示例与错误表(代码、描述、解决方案)。教程包含要构建的内容、前置条件、分步骤操作与后续方向。

风格指南建议:对读者用“you”,共享操作用“we”,避免“I”;UI 元素与菜单加粗,命令、变量、文件名用代码格式;强调少用斜体;占位符(如 API_KEY、USERNAME)用大写。安装示例可使用 pip install package-name、npm install package-name,或从源码 git clone 后 cd 并 pip install -e .。

限制:以上为写作规范与结构模板,不涉及具体工具的收费、价格或效果承诺;官方未提供的功能与数据暂未提供。