write-skill-readme — independently scanned and version-tracked by SaferSkills.
SaferSkills independently audited write-skill-readme (Agent Skill) and scored it 100/100 (green). The audit ran 55 deterministic rules across Security, Supply Chain, Maintenance, Transparency, and Community; it found 0 high-severity and 0 lower-severity findings. The full rule-by-rule trace and per-finding evidence are below. Free, methodology-open.
Findings & checks · 0 flagged
Every scanned point with the score it earned and what moved between them.
First recorded scan — no prior version to compare against.
The primary manifest — the file an agent reads to learn what this artifact does.
bensz-collect-bugs 规范记录到 ~/.bensz-skills/bugs/,不要直接修改用户本地已安装的 skill 源码;若有 workaround,先记 bug,再继续完成任务。gh 上传新增 bug 到 huangwb8/bensz-bugs;不要 pull / clone 整个仓库。为 Agent Skills 编写符合最佳实践的 README.md 用户使用指南。
用户要求为技能生成/编写/更新 README.md、用户使用指南、技能文档时使用本技能。
⚠️ 安全限制:本技能仅用于生成/更新 README.md 文件,永远不能修改目标技能的任何现有内容(包括但不限于 SKILL.md、SKILL.yaml、config.yaml、scripts/、references/ 等)。只能读取这些文件作为分析输入,不能对它们执行任何写入或编辑操作。
读取并分析以下文件:
根据技能特性选择模板:
| 技能类型 | 特征 | 推荐模板 |
|---|---|---|
| 功能型 | 主要通过 Prompt 触发,有明确工作流 | 模板 A:systematic-literature-review 风格 |
| 工具型 | 主要通过脚本/命令行调用 | 模板 B:install-bensz-skills 风格 |
| 混合型 | Prompt 优先 + 脚本备选 | 模板 C:make_latex_model 风格 |
按以下顺序生成 README.md 内容:
#### 3.1 标题与受众声明
# {技能名称} — 用户使用指南
本 README 面向**使用者**:如何触发并正确使用 `{技能名称}` skill。
执行指令与硬性规范在 `SKILL.md`;默认参数在 `config.yaml`。#### 3.2 快速开始(核心章节)
原则:Prompt 章节要短、直观、可复制。优先给用户一个“最小可用”的通用格式,让用户一眼就知道:用哪个 skill、输入是什么、会产出什么。
包含内容(推荐最小集合):
常规 Prompt 模板(写进 README,作为“最推荐用法”):
请使用 {skill_name} skill {完成xxx任务}
输入:{输入是什么(文件/路径/URL/文字/文件夹等)}
输出:{输出是什么(文件/路径/格式/数量等)}进阶 Prompt 模板(写进 README,作为“进阶用法/带参数约束”):
{常规Prompt}
另外,还有下列参数约束:
- 参数1:{说明}
- 参数2:{说明}#### 3.3 设计理念 / 功能概述
解释:
#### 3.4 提示词示例 / 使用示例
按场景分类 + 渐进式复杂度组织(但每条示例仍保持短小,避免把 README 写成“参数手册”):
### 示例 1:[场景描述](最简单)
Prompt
### 示例 2:[场景描述]
Prompt
#### 3.5 输出文件 / 配置选项
列出技能生成的文件或可配置参数,用表格或列表呈现。
#### 3.6 备选用法(如有硬编码)
仅当技能有脚本调用方式时添加此章节:
## 备选用法(脚本/硬编码流程)
### 步骤 1:[做什么]
command
#### 3.7 常见问题(FAQ)
预测小白用户可能遇到的问题,用 Q&A 形式解答。
遵循以下风格规范:
#### 4.1 小白友好设计
#### 4.2 硬编码用法处理
#### 4.3 语言风格
SKILL.md 、 /path/to/file `)将生成的内容写入技能目录下的 README.md。
README.md — 技能的用户使用指南A:经典 Prompt 应该是:
A:默认 1-2 个就够(常规 Prompt + 进阶 Prompt)。只有当技能确实存在多个高频输入源/输出形态时,再补 1-2 个场景化变体:
A:仅当技能满足以下条件之一时:
scripts/ 可以直接运行如果技能只能通过 Prompt 触发,则不需要此章节。
A:
~30 seconds. Free. No account. Every finding cites a rule and a line of evidence.