Agent Skills
返回列表
Skill 说明文档生成器

Skill 说明文档生成器

开发编程 更新于 2026.08.29

将以下提示词粘贴到你的 AI 对话框中:

请根据 https://skillhub.cn/install/skillhub.md,安装 @user_8c37677c/create-skill-readme。

技能介绍

解决什么问题

给已有 SKILL.md 的技能补齐用户可读说明文档时,常会遇到内容过技术化、章节乱填、英文翻译补丁式不一致、把 SKILL.md 内部执行链当成用户功能等问题。这个技能把 README 生成约束在“产品介绍向”的范围内,只写用户能感知的价值、使用方式和必要安全说明。

技能如何工作

它按固定优先级读取材料:当前指令、readme_formate.md 模板、目标 SKILL.md、_meta.json 与 references/。默认输出中文 README.md,并可基于定稿中文整篇生成结构一致的 README.en.md。核心流程包括:

  • 判断语言模式,避免在“仅补密钥”场景误改其它章节;
  • 按模板取舍简介、核心功能、使用指南、使用场景等节,无依据的占位章节直接删除;
  • 在需要 API Key 时插入固定的密钥获取与安全说明块;
  • 用用户向语言替换脚本、接口、解析等实现细节,保持 README 适合工程师和终端用户阅读。

适用边界

它不负责安装脚本、依赖说明、内部字段、FAQ、更新日志,除非用户明确要求或材料有硬事实。生成内容必须能回溯到当前技能资料,避免跨技能混用或脑补功能;英文不是逐句 patch,而是对最终中文的完整重译。

使用场景

  • 为刚整理完 SKILL.md 的技能补一份给用户看的中文说明,避免写成脚本手册。
  • 已有中文 README 但需要英文版本时,按同一结构整篇生成 README.en.md。
  • 发布含 API Key 要求的技能时,只插入固定密钥获取与安全说明,不改其它章节。
  • 技能资料已有功能描述和参考文档,需要按模板取舍章节并输出产品介绍向说明。

适合人员

  • 维护技能仓库的工程师,需要把 SKILL.md 转成用户可读说明。
  • 发布工具型技能的作者,需要统一中文、英文 README 结构和密钥说明。
  • 面向终端用户交付技能的开发者,需要避免把内部执行链写进文档。
  • 审核技能上架材料的运营工程师,需要检查 README 是否无脑补且可回溯。