架构师修行录

AI优化文档SKILL:屎山MD文档秒变清爽排版的压缩神器

鹿Sir上线,见字如面。

写技术文档时,你是否遇到过这些困扰?

  • 章节序号层层叠叠:1.1、1.1.1、1.1.1.1...看着就头大
  • 列表项密密麻麻,关键信息淹没在冗长描述中
  • 同样的逻辑反复出现,却散落在文档各处

今天鹿Sir要分享一个实用的文档优化工具——md-nice,让你的Markdown文档从"臃肿"变"清爽"。


核心能力:脚本预处理 + AI精加工

这套SKILL的核心逻辑很简单:你丢文档,AI干活。

效果对比

原始文档:

## 1.1 接口规范
- 参数名: username
- 类型: String
- 是否必填: 是
- 描述: 用户名,用于登录系统

压缩后:

## 接口规范
| 参数 | 类型 | 必填 | 说明 |
|------|------|------|------|
| username | String | 是 | 登录用户名 |

为什么要表格化?

原始文档是一维列表结构,4个属性需要4行展示,阅读时需要上下扫视。压缩后转为二维表格结构,1行就能呈现全部信息,横向对比更直观,信息密度提升4倍。

表格化对AI的好处:

优势
说明
结构化解析
行列关系明确,AI无需逐行理解关联关系
降低上下文负担
一行一个完整对象,独立理解无需维护上下文
便于模式识别
适合对比分析,AI更容易发现数据规律
减少Token消耗
数据更紧凑,处理大量同类数据时优势明显
方便后续处理
可直接转为JSON/CSV,便于进一步分析或生成代码

具体能做什么?

1. 去除章节序号:1.1、1.1.1 等多级序号一键清除

2. 列表表格化:属性说明、参数列表自动转为表格,提升可读性

3. 精简冗余描述:保留核心信息,去除解释性废话

4. 优化代码块:去冗余注释,合并相似示例

5. 统一文档格式:标题最多三级,保留关键标记(❌ ✅ ⚠️)


技术实现:两步构建你的文档优化流

第一步:脚本预处理(毫秒级)

调用 pre.py 脚本进行快速预处理:

python3 pre.py -s 文档.md

脚本自动完成:

  • 去除章节序号(智能跳过代码块)
  • 精简连续空行
  • 去除行尾空格

第二步:AI精加工(秒级)

对预处理后的内容进行语义级优化:

  • 列表转表格(适用于层级对比、属性说明)
  • 精简描述,用简洁短语替代长句
  • 优化代码,保留核心逻辑
  • 标注重复逻辑,突出重点

处理流程

原始文档 → 脚本预处理(毫秒) → AI精加工(秒)
              ↓                    ↓
           去序号/精简空行      表格化/语义压缩

压缩规则分工:

规则
脚本
AI
去章节序号
✅
-
精简空行
✅
-
格式清理
✅
-
列表表格化
-
✅
精简描述
-
✅
优化代码
-
✅

适用场景:谁需要这个工具?

这套方案特别适合以下人群:

✅ 技术文档写作者

  • 需要整理历史遗留的冗长文档
  • 希望统一团队文档风格

✅ 知识库管理员

  • 批量优化Wiki页面
  • 提升知识库可读性

✅ 产品经理/项目经理

  • 整理需求文档、接口文档
  • 快速生成简洁的规范说明

使用方式

在 AI工具 中(如Qoder、Claude),只需一个简单的命令:

/nice @文档.md

AI 会自动完成:

1. 读取你指定的 Markdown 文件

2. 脚本预处理(去除章节序号、精简空行)

3. AI 精加工(列表表格化、精简描述、优化代码)

4. 将优化后的内容写回原文档

就这么简单,无需记住复杂的命令行参数。


源码分享

原创不易,如果这个SKILL能解放你的生产力,欢迎购买我的SKILL合集,我会把所有实用的SKILL都打包好给你,里面的每个SKILL都是鹿Sir精心打磨过的~

网盘链接:

https://pan.baidu.com/s/1HVwxzBq5dGD8PHoPivDupg

提取码(即将失效):