SuperAPI AI 工具集

readme-writer

通用与其它

查看项目

更新于 10-16 05:49

技能介绍

用途:在项目或软件包中创建、更新和审查 README.md,让文档与实际功能保持同步。适用于新建 README、代码变更后更新文档、检查文档完整性与准确性、把零散文档扩充为完整指南,以及处理 monorepo 子目录下 README 的场景。

主要能力:从 README 所在目录递归解析代码;识别入口文件(index.ts、main.ts、package.json 的 main/exports);梳理公开导出的函数、类、类型和常量;追踪依赖关系;查找 examples/、测试文件和内联注释中的用法示例;读取 package.json 的 scripts、dependencies 和 peerDependencies。若已有 README,则对照代码找出未记录的公开 API、使用过时模式的示例、缺少的安装/快速开始/API 参考等章节,以及过时的命令。

使用方式:先确定 README 位置,monorepo 中根目录 README 覆盖整个仓库,子包 README 仅覆盖该包;然后递归分析代码库;再与现有 README 比较,列出差距和过时点;最后生成或更新内容,更新前需用户确认。新 README 可基于模板生成,并参考结构、写作原则和代码库分析等参考文献。

限制与注意事项:不用于 API 文档生成(应使用 JSDoc/TSDoc 工具)、变更日志或发布说明、非 README 的内部开发笔记,以及 Markdown 以外的文档格式。该技能依赖 humanizer 技能润色生成内容,缺少时需在设置中启用或用 /skill humanizer 调用;否则文档可能出现机械表达和夸大措辞。生成时需根据锁文件选择正确的包管理器:pnpm-lock.yaml 用 pnpm install,package-lock.json 用 npm install,yarn.lock 用 yarn,bun.lockb 用 bun install。README 超过约 200 行时应加入目录,置于标题区之后、安装章节之前。其他具体细节暂未提供。