← ClaudeAtlas

readme-craftlisted

生成标准化、语气人性化、功能多样化、符合 GFM 规范的 README.md。 骨架借鉴 Best-README-Template(顶图、shields、目录、back-to-top、底部引用区), 表达借鉴 README(GFM 全特性:Alerts、diff、折叠、居中、徽章等), 并可读取项目根目录的 AGENTS.md / CLAUDE.md 作为补充上下文。 web-app / tutorial 类项目还能自动拍下界面的真实截图(驱动浏览器实际渲染), 出多张候选交用户挑,选中的落进 assets/screenshots/ 并嵌入 README。 触发:"生成 README"、"写一份 README"、"补项目文档"、"readme 怎么写"、 "我的项目需要一个 README"、"新项目初始化 README"、"完善项目说明"、 "生成项目截图"、"README 里放界面截图"、"给项目拍截图"。 不要在以下情况使用: - 需要同时维护 CLAUDE.md(AI 上下文)+ README.md(人类阅读)双层 → 用 human-ai-docs(如已安装;没有就分开维护两个文件) - 需要 Rails 命令级细节(bin/dev、bin/rails、Kamal 部署)→ 用 readme(如已安装;没有就按 Rails 惯例手写) - 写的是 CHANGELOG / CONTRIBUTING / LICENSE 等单文件 → 直接写,不需要 skill - 只要一张 README 顶部 banner / hero 图 → 用 readme-banner(如已安装)
uwakeme/wake-skills · ★ 1 · AI & Automation · score 71
Install: claude install-skill uwakeme/wake-skills
# readme-craft 把项目本身作为主要信源,再借 AGENTS.md / CLAUDE.md 补一层"作者意图",输出一份一眼看上去"专业、像人写的、规范"的 README.md。 ## 设计原则(贯穿整个 procedure) | 原则 | 含义 | 反例 | | --- | --- | --- | | **标准化** | 固定章节顺序、固定徽章格式、back-to-top 只在长大节末尾、底部统一 reference-style 引用 | 每个 README 章节顺序都不同;徽章有的用 shield 有的用别家;每个 section 结尾都挂 back-to-top | | **人性化** | 开头用读者视角切入,保留项目个性,避免学究腔 | "This project is a comprehensive, enterprise-grade solution that leverages cutting-edge..." | | **多样化** | 从可选章节池里按项目实际需要挑,不要 10 份 README 长一个样 | 任何项目都硬塞 Demo / Architecture / Roadmap / FAQ | | **规范** | GFM 兼容、代码块带语言、表格列对齐、shields.io badge 用真实值 | `npm i` 不写语言;徽章写 `YOUR-USERNAME` 占位没替换 | 风格基线:**像一份好的开源项目 README,不是像一篇论文或营销页。** --- ## Inputs to collect 按需读取,不需要全部问用户: - **项目路径**:默认当前工作目录 - **项目类型**:library / cli / web-app / api / tutorial / other - 优先从 manifest 自动推断(见 Step 1),推断不出再问 - **目标语言**:multi-select,**English 必选且默认勾选**(详见 Step 1.5) - 跳过询问的情形:用户明确说"不要问"、给具体语言列表、或选已有的 README 文件作为唯一源 - **是否覆盖已有 README**:默认备份后全量重写(`README.md.bak`) - 用户明确说"增量"才做局部更新 - **README banner**:默认自动生成,不问(能力检测与降级见 Step 4.5) - 用户说"不要 banner"、或现有 README 已引用可用的 banner / logo 图时跳过 - **界面截图**:默认仅 web-app / tutorial 自动拍(web-app 的 Screenshots 章节、tutorial 的 Steps 配图) - 用户说"不要截图" → 跳过 - 其它项目类型 → 跳过,不问 - 候选多张时交用户挑(见 Step 4.6) --- ## Procedure ### Step 1 — 扫描项目结构 读取根目录列表和关键 manifest,确定 name、version、description、scripts、dependencies、license。 | 类型 | 关键文件 | | --- | --- | | Node | `package.json`、`pnpm-lock.yaml`、`yarn.lock`、`package-lock.json` | | Python | `pyproject.t