← ClaudeAtlas

write-skill-readmelisted

当用户明确要求"生成技能 README"、"编写用户指南"或"更新技能文档"时使用。为 Agent Skills 编写符合最佳实践的 README.md 用户使用指南。自动分析技能结构(SKILL.md、config.yaml、scripts/),按模板生成小白友好的文档。
huangwb8/skills · ★ 37 · AI & Automation · score 86
Install: claude install-skill huangwb8/skills
# Write Skill README ## 与 bensz-collect-bugs 的协作约定 - 因本 skill 设计缺陷导致的 bug,先用 `bensz-collect-bugs` 规范记录到 `~/.bensz-skills/bugs/`,不要直接修改用户本地已安装的 skill 源码;若有 workaround,先记 bug,再继续完成任务。 - 只有用户明确要求“report bensz skills bugs”等公开上报时,才用本地 `gh` 上传新增 bug 到 `huangwb8/bensz-bugs`;不要 pull / clone 整个仓库。 为 Agent Skills 编写符合最佳实践的 README.md 用户使用指南。 ## 触发条件 用户要求为技能生成/编写/更新 README.md、用户使用指南、技能文档时使用本技能。 ## 核心工作流 > ⚠️ 安全限制:本技能**仅用于生成/更新 README.md 文件**,**永远不能修改目标技能的任何现有内容**(包括但不限于 SKILL.md、SKILL.yaml、config.yaml、scripts/、references/ 等)。只能读取这些文件作为分析输入,不能对它们执行任何写入或编辑操作。 ### 步骤 1:分析技能结构 读取并分析以下文件: 1. **SKILL.yaml** — 技能元数据(name、description、version、author、metadata) 2. **SKILL.md** — 技能核心规范(触发条件、工作流、输入输出) 3. **config.yaml**(可选)— 可配置参数 4. **scripts/** 目录(可选)— 硬编码用法 5. **references/** 目录(可选)— 参考文档 ### 步骤 2:确定 README 类型 根据技能特性选择模板: | 技能类型 | 特征 | 推荐模板 | |---------|------|---------| | **功能型** | 主要通过 Prompt 触发,有明确工作流 | 模板 A:systematic-literature-review 风格 | | **工具型** | 主要通过脚本/命令行调用 | 模板 B:install-bensz-skills 风格 | | **混合型** | Prompt 优先 + 脚本备选 | 模板 C:make_latex_model 风格 | ### 步骤 3:生成核心章节 按以下顺序生成 README.md 内容: #### 3.1 标题与受众声明 ```markdown # {技能名称} — 用户使用指南 本 README 面向**使用者**:如何触发并正确使用 `{技能名称}` skill。 执行指令与硬性规范在 `SKILL.md`;默认参数在 `config.yaml`。 ``` #### 3.2 快速开始(核心章节) **原则**:Prompt 章节要**短、直观、可复制**。优先给用户一个“最小可用”的通用格式,让用户一眼就知道:用哪个 skill、输入是什么、会产出什么。 包含内容(推荐最小集合): - **常规 Prompt(最小可用)**(1 个)— 必须用统一格式说明“用哪个 skill / 输入 / 输出” - **进阶 Prompt(可选)**(1 个)— 在常规 Prompt 基础上追加“参数约束”,不展开长篇叙述 常规 Prompt 模板(写进