← 返回
未分类

skill说明文档生成

为 Skill 生成或补全面向用户的 README.md(中文)与可选 README.en.md;或在已有 README 中仅追加 REDFOX_API_KEY 固定格式块时使用。
为 Skill 生成或补全面向用户的 README.md(中文)与可选 README.en.md;或在已有 README 中仅追加 REDFOX_API_KEY 固定格式块时使用。
膤小羽
未分类 community v1.0.2 3 版本 100000 Key: 无需
★ 0
Stars
📥 73
下载
💾 0
安装
3
版本
#latest

概述

Create Skill README

硬约束

写权限:仅可写入目标 Skill 的 README.mdREADME.en.md(英文时)。禁止改 SKILL.mdscripts/references/ 等其它文件;禁止为 README 跑安装/格式化命令。

上下文隔离:每一轮新目标 Skill 须独立收集材料;禁止沿用对话中其它 Skill 的措辞、章节或产品名。同一 Skill 续写时可读已有 README 做增量修改。

权威来源(优先级从高到低):

  1. 用户本条消息(产品名、一句话简介、功能介绍、语言模式、souce
  2. references/readme_formate.md 第一节大纲 + 第三节正文模版
  3. 目标 SKILL.mdnamedescription、用户向能力描述; Agent 执行链)
  4. _meta.json / metadata、目标 references/(数据口径等硬事实)
  5. assets/*.md:仅语气与排版参考,不得抄其中的商店名/变量名

产出定位

生成产品介绍向用户说明,不是技术文档或 Agent 手册。

要写不写(除非用户显式要求或材料有硬事实)
------------------------------------------
用户价值、怎么说、得到什么脚本参数、内部字段、实现链路、运行环境/依赖安装
大纲表【必选】节 + 材料满足纳入条件的【可选】节FAQ、注意事项、更新日志、特色亮点、重要数据说明
固定格式节(密钥)逐行复刻第三节同义改写固定 bullet、无材料填空、文末「详见 references…」

防脑补总则:第三节模版中有占位符的节,无对应可核材料则整节或整子块删除,不留空壳标题。description 只用于简介开篇一句(用户未提供一句话简介时);禁止用 description 自动生成「功能介绍」或扩写 FAQ。

语言模式

用户本条指令优先于默认。

模式触发行为
------------
仅补密钥已有 README(或用户提供全文)且要求加 apikey / REDFOX_API_KEY / 红狐密钥等只插入/替换 ## 密钥获取与安全说明(6 条固定 bullet);不改其它章节;跳过模版确认
仅中文「只要中文」「不要英文」等只写 README.md
要英文「英文版」「README.en」等以当前 README.md 全文重译 README.en.md;默认不改中文
默认未声明上述README.md,再译 README.en.md

英文:README.en.md 结构与中文完全一致,整篇重译(禁止 patch 旧英文、禁止从 SKILL.md 另写结构)。一级标题 # [英文名] / [skill-id]skill-id = name 原文。「红狐 hub」固定译 RedFoxHub

仅补密钥

触发:须同时满足「已有文档」+「意图仅为补密钥」(见上表触发词:apikeyREDFOX_API_KEY、红狐密钥等;不含「生成 readme」「优化全文」)。

落盘

  1. 只读现有 README 为基底;非密钥段落一字不改
  2. 写入第三节 / assets/demo.README.md6 条红狐 bullet(souce 默认 github
  3. 位置:已有该节则替换;否则插在 ## 功能特性## 使用指南 之间

完整生成流程

  1. 读模版readme_formate.md 第一节~第三节(产出英文时加第四节)
  2. 收材料name、用户本条补充、是否写密钥节、souce;按需读 _meta.json、目标 references/
  3. 模版确认:用户已说「按默认模版」「直接生成」「不要问」或 @ 了目标 Skill 并明确要求写 README → 直接落盘,不提问;否则简短说明后默认 A(约 10 秒无选 B 视为 A)
  4. 写中文:按第一节纳入条件取舍章节,按第三节落盘;密钥固定块与第三节逐行一致
  5. 写英文(若适用):重译定稿中文
  6. 回复:给出文件路径 + 简短核对(见下「落盘前自检」);默认不追问可选模块扩展

章节取舍(摘要,细则见 readme_formate 第一节)

章节规则
--------
一级标题# [中文名] / [skill-id]skill-id = name 原文,禁止改
简介开篇一句 + 核心价值 + 适用对象;功能介绍子块仅用户本条提供时写入
核心功能仅写 SKILL.md用户可感知的能力点;禁止脚本名与内部步骤;不凑条数
特色亮点默认删除;仅材料有明确 2~4 条差异化卖点时写入
密钥获取与安全说明材料或用户本条有 API Key / REDFOX_API_KEY 需求时写入 6 条固定块
使用指南必选;话术/速查表来自 SKILL.md 示例或用户场景,禁止编造命令
使用场景材料有场景信息则写四列表格;无实质则并入简介或删除
FAQ / 注意事项 / 更新日志 / 技术附录仅用户显式要求

产品介绍文风

简介、功能、使用指南、场景:通俗、面向用户。技术词替换(中英文同理):HTML→可视化页面;API/接口→服务/数据能力;抓取/解析→获取/读取;JSON/Python/脚本→按语境用「数据处理/自动执行」。

落盘前自检

  • [ ] 只改了目标 README.md / README.en.md
  • [ ] 无其它 Skill 内容混入;skill-id 未改
  • [ ] 无未替换 [占位符];无 FAQ/注意事项等默认禁写节(除非用户要求)
  • [ ] 固定格式节与第三节逐行一致;密钥 6 条、souce 默认 github;英文 RedFoxHub
  • [ ] 功能/场景/话术均可回溯到目标材料或用户本条;无运行环境说明
  • [ ] 英文与中文结构、列表条数一致

相关文件

路径用途
--------
references/readme_formate.md大纲、占位符、正文模版(权威
assets/demo.README.md密钥块与语气参考

版本历史

共 3 个版本

  • v1.0.2 Initial release 当前
    2026-05-27 15:34 安全 安全
  • v1.0.1 Initial release
    2026-05-21 15:21 安全 安全
  • v1.0.0 Initial release
    2026-05-20 16:27 安全 安全

安全检测

腾讯云安全 (Keen)

安全,无风险
查看报告

腾讯云安全 (Sanbu)

安全,无风险
查看报告

🔗 相关推荐

dev-programming

Mcporter

steipete
使用 mcporter CLI 直接列出、配置、认证及调用 MCP 服务器/工具(支持 HTTP 或 stdio),涵盖临时服务器、配置编辑及 CLI/类型生成功能。
★ 195 📥 67,512
dev-programming

Github

steipete
使用 `gh` CLI 与 GitHub 交互,通过 `gh issue`、`gh pr`、`gh run` 和 `gh api` 管理议题、PR、CI 运行及高级查询。
★ 677 📥 326,498
content-creation

热点分析与爆款挖掘

user_8c37677c
热点分析与爆款挖掘工具。当用户询问"全网最新话题"、"最近有什么热点"、"XX话题热度分析"、"XX有什么爆款内容"、"选题推荐"、"热点追踪"、"爆款挖掘"或"内容定位建议"时,必须使用本skill。自动挖掘抖音、小红书、公众号、快手、B
★ 0 📥 302