Skip to main content

Skill README 生成

@ aquarius-wing1912026.7.15skill-readme-generation

给已有 skill 的 SKILL.md 派生一对双语人话说明——英文 README.md + 中文 README.zh.md, 直接落到公司自建官网的 skill 详情页。

官方精选文档知识

基础信息

名字/名称
Skill README 生成
描述说明
给一个已有 skill 目录 (含 SKILL.md) 生成符合 tranfu-skills README 规范的英文 `README.md` 与中文 `README.zh.md`, 供公司自建官网的 skill 详情页解析与展示。产出 = frontmatter (`description` + 最多 3 条 `prompt_examples`) + 四段正文 (elevator pitch / 什么时候用它 / 它会产出什么 / 前置条件与边界), 不生成中英文切换行。触发于: "给这个 skill 加个 README / 给 own-skills/xxx 补一份 README / 按 tranfu 规范生成 skill 的 README / 生成 skill README / skill readme generation / 把 SKILL.md 派生一份人可读说明 / 给 skill 加个说明文档 / 跟 skill-name-generation 一样给这个 skill 也做一份 README / 把 own-skills/ 下所有还没 README 的 skill 都补齐"。也覆盖存量批量补齐场景。Do NOT trigger when: 改现有 README 的某一段 (那是普通编辑) / 从零建 SKILL.md 或整个 skill (那是 `skill-create-workflow`) / 给 skill 起 display_name 或 slug (那是 `skill-name-generation` / `skill-domain-framing`) / 判断某段内容是否适合做成 skill (那是 `skill-content-fit`) / 给非 skill 的普通项目写 README 或项目文档 / CI 校验现有 README frontmatter 是否合规 (那是脚本的活)。产出物仅落盘到目标 skill 目录内的 `README.md` 与 `README.zh.md`, 绝不改动它的 `SKILL.md` 或其他任何仓库文件。

Skill README 生成

给已有 skill 的 SKILL.md 派生一对双语人话说明——英文 README.md + 中文 README.zh.md, 直接落到公司自建官网的 skill 详情页。

什么时候用它

为新 Skill 写说明:

我刚做完一个新 skill, SKILL.md 已经写好, 现在要挂到公司官网详情页, 想让 skill 顺手把配套 README 也生成好, 我不用一段段口述。

批量补充 README:

own-skills/ 下还有一批老 skill 只有 SKILL.md, 一直没配 README——想按同一套规范一次性补齐, 每个目录一份独立文件, 绝不合并。

更新旧版 README:

某个 skill 的旧 README 是单语中文, 或骨架不合当前规范, 我明说「按最新双语规范重生成」, 就直接覆盖两份文件。

发布前补说明:

我要把某个 skill 挂到公司自建官网的详情页, 详情页会读 README 开头的示例提问, 显示成不同场景的用法示范——README 没补齐, 详情页就没内容可显示。

参考现有 README:

参照另一个已有好 README 的 skill, 说「跟 skill-name-generation 一样, 给这个 skill 也做一份」——skill 会照那份的骨架, 落到目标 skill 自己的 SKILL.md 上。

不接:

只想改现有 README 里的某一段 → 普通编辑就够,不用 skill;从零建 SKILL.md 或整个 skill → skill-create-workflow;只给 skill 起显示名或英文目录名 → skill-name-generation / skill-domain-framing;判断某段素材值不值得做成 skill → skill-content-fit;SKILL.md 太简陋时先用平台的 skill 编辑能力补齐。

它会产出什么

一次调用产两份文件——英文 README.md + 中文 README.zh.md, 结构对应但绝不逐词直译。

  • 落盘: <目标 skill 目录>/README.md (全英文正文) 与 <目标 skill 目录>/README.zh.md (全中文正文)
  • 开头元数据: 一条普通人看得懂的 description 加最多 3 条自然口语 prompt_examples, 每条覆盖不同触发场景
  • 不放语言切换行: 开头元数据结束后直接进入 H1
  • 正文四段: 开场一句摘要 → 什么时候用它 → 它会产出什么 → 前置条件与边界, 每版 30-80 行
  • 改成人话: 中文版逐句把作者圈才懂的行话过滤成普通中文, 让路过详情页的普通同事也扫得懂
  • 完成汇报: 终端打印两份落盘路径、总行数、示例提问条数与覆盖场景, 以及「拿不准之处」一行
  • 绝不会做: 改动目标 skill 的 SKILL.md, 改动仓库任何其他文件, 联网调 API, 自己另起子任务并发跑

前置条件与边界

前置:

目标是一个已有的 skill 目录, 里面必须已经有 SKILL.md (开头元数据完整、有 description)——本 skill 不建 skill 骨架, 只在已有骨架之上派生 README。无外部依赖: 不联网, 不调 API, 不启动 subagent。

相邻 skill 分工:

动作 交给
从零建 SKILL.md 或整个 skill skill-create-workflow
起 skill 显示名 (中英文) skill-name-generation
起 skill 英文名 / 目录名 skill-domain-framing
判断素材值不值得做成 skill skill-content-fit
补齐过于简陋的已有 SKILL.md 平台 skill 编辑能力 / 直接编辑

不接的场景:

  • 改现有 README 里的某一段 (普通编辑就够)
  • 给非 skill 的普通项目写 README 或项目文档
  • CI 校验现有 README 开头元数据是否合规 (那是脚本的活)

微妙边界:

  • 目标目录已有 README.md 或 README.zh.md, 用户没明说要「重生成 / 覆盖」→ 询问一次, 绝不擅自覆盖
  • 目标 SKILL.md 太简陋(缺触发场景 / 主流程)→ 停下,建议先用平台的 skill 编辑能力补齐再回来生成,不硬凑一份内容单薄的 README
  • 目标 skill 没定显示名 → 照常生成 README, 汇报里提醒用户可路由 skill-name-generation

一起来搞事情

关注我们的社交媒体,加入社群获取最新动态

微信交流群

扫码加入微信群

微信二维码