SuperAPI AI 工具集

documentation-writer

写作与研究

查看项目

更新于 10-15 16:43

技能介绍

用途:为代码、API 和项目生成较全面的技术文档,包括 README 文件、API 参考、代码注释(JSDoc、docstrings、XML)以及架构文档。触发方式为 /docs 命令,或用户直接提出文档需求、需要 README 或 API 文档时。

主要能力:提供 README 模板,覆盖项目简介、功能清单(含进行中标记)、快速开始(克隆、安装依赖、启动开发服务器)、安装说明(前置要求与环境变量)、使用示例、API 参考(参数表格与返回值)、贡献流程和许可证。同时给出 JSDoc 注释示例,说明参数、返回值、异常与示例写法;以及 C# XML 文档注释示例,说明 summary、param、returns、exception 与 example 标签。

使用方式:在兼容环境中通过 /docs 命令或直接描述文档需求来调用;技能会按模板与注释规范组织内容。示例中的命令(如 git clone、npm install、npm run dev)和代码保持原样。

适用场景:需要快速补齐项目 README、整理 API 参考、为函数或方法补充注释、或编写架构说明时使用。

限制:资料仅提供模板与注释示例,未说明具体支持的编程语言范围、生成质量、是否收费或价格;未提供安装命令、平台支持细节或使用步骤;官方文本为空,相关事实暂未提供。