SuperAPI AI 工具集

readme-generator

写作与研究

查看项目

更新于 10-15 17:22

技能介绍

用途:为项目从零创建 README.md,或改进既有 README 的结构与平衡性,采用 Deep Insight/Strands SDK 文档风格,把技术文档转为更友好的格式。不适用于纯 API 文档(应使用 API 文档生成器)或内部技术规格(应使用架构文档)。

主要能力:借助 Claude Code 原生工具(Read、Glob、Grep)探索代码库,收集项目结构、依赖与框架、关键功能等信息,再按 Deep Insight 模式生成文档。该模式的结构为:居中头部(Logo、标题、一句话价值主张、徽章、快速导航链接)、Latest News、Why [Project]、Quick Start(2 分钟内可跑通)、Demo(视频/截图与示例输出)、Installation(详细安装与多种配置方式)、Architecture(系统概览图,复杂系统可加文本示意图)、Contributing、License、Acknowledgments/Contributors。

关键原则:视觉优先(Logo、居中布局、徽章、架构图)、深浅平衡、渐进式展开(顶部快速呈现价值,细节后置)、代码优先(展示可运行示例)、专业但易读。写作规范包括:Logo 约 110x210px 或按比例调整;图片居中约 750px 宽;仅使用相关徽章(提交活跃度、许可证、Python 版本);导航链接用 ◆ 分隔;Latest News 最新在前,使用 [YYYY/MM] 格式;收益点用 emoji;代码块标注语言;段落控制在 3-4 行。

使用方式:先探索代码库——用 Glob 定位入口文件(main.py、app.py、*.ipynb)、配置文件(pyproject.toml、requirements.txt、.env.example)、资源(logo、截图、架构图)与文档(CLAUDE.md、现有 README、CONTRIBUTING.md);用 Read 查看依赖、主要导入与环境变量,理解入口逻辑、命令行参数或 API 端点及产出物;再按上述结构逐节构建 README。

验证与限制:完成前需检查视觉呈现、章节完整性、命令与链接有效性、非技术用户可读性、风格一致性。需避免缺少 logo 或视觉元素、头部未居中、Latest News 过期、缺少演示视频或截图、通用占位文本、内部链接失效、格式不一致等问题。文档中的具体安装命令与配置示例以资料给出的通用模板为准,实际项目参数需按自身情况替换;未提供该技能的具体安装方式、收费与平台支持信息。