SuperAPI AI 工具集

documentation-writer

写作与研究

查看项目

更新于 10-15 19:50

技能介绍

用途:该技能用于为代码、API 或系统撰写面向开发者的文档,读者定位为聪明但从未接触过该代码库的新成员。触发条件包括用户希望产出概览、快速开始、概念、API 参考、使用模式与故障排查等内容。

主要能力:当用户提供代码或规格后,按固定结构生成文档,包含六部分:概览(用 2 至 3 句说明它做什么、为何存在)、快速开始(5 分钟内跑起来)、核心概念(解释心智模型而非仅罗列 API 表面)、API 参考(每个公开函数或端点,含参数、返回值与示例)、常见模式(3 个带代码示例的典型用法)、故障排查(5 个常见问题及解决方案)。

使用方式:在提示模板中把代码或规格粘贴到 <code_or_spec> 变量位置,再按上述要求生成文档。资料未提供具体安装命令或调用命令,暂未提供。

适用场景:为库、API、内部系统或代码模块补充开发者文档,尤其适合需要统一文档结构、降低新人上手成本时使用。

限制:仅依据用户粘贴的代码或规格生成,未提供的内容不应编造;该资料只给出提示模板结构,未说明收费、价格、平台支持、输出语言或效果保证,这些信息暂未提供。