agentleFS
xieqiyongxieqiyong/skills/llm-doc-china-skills/SKILL.md

skill-format-optimizer

Skill4 starsChanged 5 months agoApache-2.0View on GitHub

优化 skill 文档的格式与结构,使其对 LLM 更易理解、更易触发、执行更准确。当用户说"优化这个 skill"、"重写 skill 格式"、"让 skill 更好理解"、"skill 文档结构有问题"、"为什么 skill 没有触发"时使用。也适用于从零开始写一个新 skill 并希望格式规范的情况。

The file

Files
SKILL.md

Skill Format Optimizer

将现有 skill 文档重新格式化,使 LLM 读取时歧义更少、行动更准确。


[核心原则] LLM 理解文档的方式

在优化任何 skill 之前,必须理解 LLM 与人类读文档的根本差异:

维度人类读文档LLM 读文档
理解层级通过字体大小、视觉权重通过 token 序列和语义标记
处理歧义结合经验推断歧义 → 随机选择或忽略
记忆结构可回翻、有空间记忆上下文窗口线性扫描
优先级感知视觉突出即重要需要显式标注才能识别权重
最佳输入叙述性散文条件语句 + 原子信息单元

推论:好的 skill 文档 = 决策树,不是说明文。


[执行流程] 优化一个 skill 的步骤

步骤 1:读取并诊断原文档

读取目标 skill 的 SKILL.md,对照下方【诊断清单】逐项检查。
输出诊断报告,格式:
  问题类型 | 原文位置 | 严重程度(高/中/低)

步骤 2:按优先级重写

优先级顺序(从高到低):

  1. CRITICAL 规则是否清晰可见
  2. 触发条件是否可被 LLM 准确匹配
  3. 执行步骤是否原子化、有序
  4. 示例是否成对(正例 + 反例)
  5. 层级是否扁平(≤3 级)

步骤 3:验证输出

重写后,对照【格式规范】检查每一节,确认无回退。


[诊断清单] 识别格式问题

问题类型 A:语义模糊

症状:

  • 出现"一般来说"、"通常情况下"、"视情况而定"、"可以考虑"
  • 规则没有明确的条件边界
  • 同一概念有多种表述方式

检测方法: 问自己:"如果只看这句话,LLM 能确定地知道该做什么吗?" 如果答案是"不确定",这是语义模糊问题。

修复方式:

# 修复前
通常应该先查看文件再操作。

# 修复后
规则:每次操作文件前,必须先用 view 工具读取当前内容。
例外:文件内容已在本次对话上下文中时,跳过此步骤。

问题类型 B:散文包裹规则

症状:

  • 关键规则埋在段落中间
  • 需要读完整段才能提取行动指令
  • 规则和背景解释混在一起

检测方法: 能否在 5 秒内从这段文字提取出"做 X"或"不做 Y"? 如果不能,是散文问题。

修复方式:

# 修复前
在处理文件时,需要注意不同类型的文件有不同的处理方式,
PDF 文件通常需要特殊的工具来处理,而 Word 文档则需要另外的工具,
所以要根据文件类型来决定使用哪种方法。

# 修复后
文件类型 → 使用工具:
- .pdf      → 读 pdf/SKILL.md
- .docx     → 读 docx/SKILL.md
- .xlsx     → 读 xlsx/SKILL.md
- 未知类型  → 读 file-reading/SKILL.md

问题类型 C:缺少示例或示例单向

症状:

  • 只有描述,没有输入→输出的具体映射
  • 只有正例,没有反例
  • 示例与规则描述重复,没有增加信息

修复方式: 示例必须成对出现,覆盖边界情况:

✓ 正例:用户说"帮我做个 PPT" → 先读 pptx/SKILL.md,再执行
✗ 反例:用户说"解释一下什么是 PPT" → 不触发此 skill,直接回答
边界:用户说"把这个 Word 文档转成 PPT" → 同时读 docx/SKILL.md 和 pptx/SKILL.md

问题类型 D:层级过深或装饰性层级

症状:

  • 标题嵌套超过 3 级(#### 及以下)
  • 标题名称语义相近("注意事项" > "重要提示" > "关键规则")
  • 层级只是视觉装饰,没有传递父子关系

修复方式: 将深层嵌套重构为扁平分区:

# 修复前(4 级嵌套)
## 文件处理
### PDF 处理
#### 扫描版 PDF
##### 含表格的扫描版 PDF

# 修复后(扁平分区)
## [文件处理] PDF 扫描版(含表格)
触发条件:用户上传了扫描版 PDF 且提到"表格"
处理方式:...

问题类型 E:触发条件不可匹配

症状:

  • description 只描述功能,没有列触发关键词
  • 触发描述太宽泛("处理文件时使用")或太窄(只列了一个词)
  • 没有列"不触发"的情况

修复方式: 触发条件要写成分类器格式(见下方【触发条件写法】)。


问题类型 F:CRITICAL 规则不可见

症状:

  • 必须遵守的约束与普通说明混排
  • 所有内容都用相同的格式呈现
  • CRITICAL 标注泛滥(超过 3 处),导致无优先级

修复方式:

⚠️ CRITICAL(全文最多 2-3 处):
- 必须在第一步读取 SKILL.md,否则后续所有步骤无效
- 输出文件必须放在 /mnt/user-data/outputs/,否则用户无法访问

[格式规范] 优化后的 skill 结构模板

---
name: skill-name
description: [触发关键词列表] + [功能描述] + [不触发情况]
---

# Skill 名称(一句话说明用途)

⚠️ CRITICAL:[最重要的 1-2 条约束,其余不要标 CRITICAL]

---

## [触发] 什么时候使用

触发(满足任一即触发):
- 用户输入包含:关键词1、关键词2、关键词3
- 用户上传了:文件类型或工件类型
- 用户意图是:具体动作描述

不触发(即使相关也不触发):
- 情况1(原因)
- 情况2(原因)

---

## [步骤] 执行顺序

步骤 1:[动作]
  输入:期望的输入
  输出:期望的输出
  工具:使用的工具名

步骤 2:[动作]
  输入:上一步的输出
  输出:...

步骤 N:[收尾动作]
  必须:[强制要求,如 present_files]

---

## [规则] 约束与边界

必须:
- 规则1
- 规则2

禁止:
- 禁止行为1(后果说明)
- 禁止行为2

例外:
- 情况A → 改为执行B

---

## [示例] 输入 → 输出映射

✓ 正例1:
  输入:"[真实用户语句]"
  行动:步骤1 → 步骤2 → 输出X

✓ 正例2(边界情况):
  输入:"[边界用户语句]"
  行动:...

✗ 反例(不应触发):
  输入:"[看似相关但不应触发的语句]"
  行动:直接回答,不使用此 skill

---

## [参考] 扩展资源(可选)

仅在需要时读取:
- references/detail.md:[什么时候读,读什么]
- scripts/process.py:[什么时候执行]

[触发条件写法] description 字段的优化规范

description 是 skill 能否被触发的核心,必须同时包含:

结构要求

[功能一句话] + 当用户[触发场景1]、[触发场景2]、[触发场景3]时使用。
即使用户没有明确说[具体词],只要[意图描述],也应触发。
不适用于:[排除情况]。

写作原则

原则说明
关键词密度同义词、近义词都要列出(用户说法多样)
意图覆盖列出用户的目的,而不只是输入形式
显式排除列出相似但不该触发的场景
推动性语气宁可多触发,不要漏触发

示例

# 差(只描述功能)
处理 Word 文档的 skill。

# 好(触发器格式)
创建、编辑、修改 Word (.docx) 文档。当用户提到 Word、文档、报告、
备忘录、信函、.docx,或要求"生成一份文件"、"写个报告"、"做个模板"时使用。
即使用户没有说"Word",只要最终产物是需要下载的格式化文档,也应触发。
不适用于:PDF、纯文本、Google Docs、仅查看文件内容(不需要生成文件)。

[表格写法] 何时用表格,如何写好表格

适合用表格的场景

  • 条件 → 行动 的映射(最佳场景)
  • 多个选项的对比(列数 ≤ 4)
  • 配置参数列表

表格写作规则

规则1:每个单元格只包含原子信息(不超过 15 字)
规则2:列名直接说明数据含义,不用"备注"、"说明"等模糊列名
规则3:如果单元格需要超过 15 字,改用列表或独立小节
规则4:表格列数最多 4 列,超过则拆分

示例

# 差(单元格内嵌散文)
| 场景 | 处理方式 |
|------|---------|
| 当用户上传了文件且文件类型不明确时 | 应先判断文件类型,然后根据情况选择对应的处理工具,但如果上下文已有内容可跳过 |

# 好(原子单元格)
| 用户输入特征 | → 执行动作 |
|------------|-----------|
| 提到 .pdf | 读 pdf/SKILL.md |
| 提到 .docx | 读 docx/SKILL.md |
| 文件类型未知 | 读 file-reading/SKILL.md |
| 内容已在上下文 | 跳过读取,直接处理 |

[层级写法] 标题层级的使用规范

允许的层级深度

# 一级:skill 名称(全文唯一)
## 二级:功能分区([触发] / [步骤] / [规则] / [示例])
### 三级:子分类(仅在内容确实需要分组时使用)
#### 禁止使用(将内容提升或拆分为独立 skill)

二级标题命名规范

用方括号前缀标注语义类型,让 LLM 无需理解上下文即可知道这一节的作用:

前缀含义示例
[触发]触发条件## [触发] 什么时候使用
[步骤]执行顺序## [步骤] 如何执行
[规则]约束条件## [规则] 必须遵守的约束
[示例]输入输出对## [示例] 典型场景
[参考]扩展资源## [参考] 何时读哪个文件

[长度控制] skill 文档的体积管理

文档范围建议长度超出时的处理
SKILL.md 全文≤ 500 行将细节移入 references/
单个规则描述≤ 2 行拆分为多条独立规则
单个示例≤ 5 行只保留核心步骤
表格单元格≤ 15 字改用列表或独立小节

当 SKILL.md 接近 500 行时,加入分层加载指引:

## [参考] 扩展文档

基础用法见本文件。以下文件按需读取:
- references/edge-cases.md:处理异常输入时读取
- references/advanced.md:用户要求高级功能时读取

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.