SuperAPI AI 工具集

feature-documentation

写作与研究

查看项目

更新于 10-15 21:08

技能介绍

用途:该技能用于撰写功能文档、发布说明(release notes)、用户指南和产品文档,面向终端用户、开发者与利益相关者等不同读者。

主要能力:按“用途优先”组织内容,从功能做什么、解决什么问题、目标用户与核心价值入手,再逐层展开到实现细节;支持多入口阅读,并交叉引用相关功能、依赖与前置条件。内容框架包含概述、工作原理(核心功能、用户流程、系统集成)、实现(技术要求、配置、代码示例)与参考(参数、错误处理、性能限制与优化建议)。

使用方式:采用场景化示例,如“场景 1:电商商品搜索”,写明上下文、步骤与预期结果;按任务组织为快速开始(5 分钟内首次成功)、常见任务、高级用法与故障排查。API 文档可给出路径、方法、摘要、描述、速率限制与响应时间等字段。跨角色沟通提供高管摘要模板(业务影响、开发工作量、依赖、成功指标、风险与缓解)和发布说明格式(新增内容、面向开发者的代码示例、破坏性变更与迁移要求)。

适用场景:功能上线文档、版本发布说明、面向用户的操作指南、API 参考与产品说明。

限制:资料未提供具体安装命令、平台支持、收费方式或实际效果数据;文档质量检查清单要求代码示例经过测试、覆盖正常路径与边界及错误场景、兼顾技术与非技术读者、标注版本信息并规范标题结构与图片替代文本。