前言¶

给 Skill 写 README 是件不复杂但很磨人的事：Skill 本身的能力已经在 SKILL.md 里写清楚了，可面向用户的那一份说明往往缺位——要么是从零开始组织语言，要么是仓库里已经有 README，只想在末尾补一段固定格式的 API Key 说明，懒得手改。

skill说明文档生成 就是针对这两个场景的 Skill。下面介绍它是什么、能做什么、怎么用。

这是什么¶

一句话定位：为 Skill 生成或补全面向用户的 README.md（中文），可选生成 README.en.md；或者在已有 README 中仅追加 REDFOX_API_KEY 固定格式块。

• 坐标：@user_8c37677c/create-skill-readme
• 发布者：user_8c37677c
• 来源：community（社区投稿，非官方内置）
• 分类：dev-programming
• 版本：1.0.2
• 标签：requires_api_key=false
• 官方地址：https://api.skillhub.cn/user_8c37677c/create-skill-readme

它解决的是”文档写不好或懒得写”的问题，不改变 Skill 本身的功能逻辑。

核心功能¶

已核实到的能力有两项。

1、生成或补全 README.md。面向用户，中文书写。输入的是某个 Skill 的实际情况，产出是一份说明文档。
2、可选生成 README.en.md。英文版本，与中文版配套，不是必选项。
3、在已有 README 中追加 REDFOX_API_KEY 固定格式块。这个分支只在”文档已经存在、只缺一段 Key 说明”时使用，不重写整份文档。

安装与启用¶

说明：官方页面在写作时无法访问（见文末”注意”），安装命令、目录约定和各宿主的具体配置方式均未在资料中核实到，这里不臆造。

基于通用 SKILL.md 格式，通常的启用路径是把它作为 Skill 提供给宿主加载，具体以 SkillHub 页面给出的命令为准。

典型用法¶

官方资料只给出了能力描述，没有提供可复现的命令示例或输入样例，因此下面只说明使用方式，不给具体输出。

1、需要一份全新的面向用户文档时，走”生成或补全 README.md”分支。
2、需要英文版时，在第一步基础上追加”生成 README.en.md”。
3、README 已经存在、只想补 REDFOX_API_KEY 说明时，走”仅追加固定格式块”分支。

第三个分支的关键点是”仅追加”：不改动已有内容，只在指定位置插入约定格式的块。

适用场景与注意¶

适合谁：给自己或团队维护的 Skill 补齐用户侧文档的人；以及文档已就位、只需要标准化补一段 API Key 说明的人。

注意：

1、requires_api_key=false 指的是该 Skill 自身不需要 API Key 才能运行，不代表它处理的内容里没有 Key。追加 REDFOX_API_KEY 块时，那段配置依然是要填真实值的。
2、它是社区来源（community），由 user_8c37677c 发布，使用前建议自行核对文档内容与目标 Skill 是否一致。
3、本次写作时官方页面与 SkillHub 页面均无法访问，版本号（1.0.2）、评分与下载量只能依据抓取到的资料，可能不是最新。

结尾¶

这个 Skill 的价值在于把”写 README”这件低技术含量但高频的活标准化：要么补全整份文档，要么只追加一段固定格式块，两条路径都不碰 Skill 的功能代码。如果你手上的 Skill 文档长期欠账，或者 Key 说明每次格式都不统一，可以从这里开始试。

官方地址：https://api.skillhub.cn/user_8c37677c/create-skill-readme

SkillHub 页面：https://www.skillhub.cn/skills/user_8c37677c/create-skill-readme