name: llm-doc-writer description: 为LLM上下文编写token高效的文档。适用于创建CLAUDE.md、README、技术文档、智能体指令或任何由AI助手使用的文档。
LLM优化文档编写
核心原则
| 原则 | 规则 |
|---|---|
| 密度 | 信息最大化，token最小化 |
| 格式 | 表格 > 段落，列表 > 段落 |
| 无冗余 | 禁止填充词（见下方列表） |
| 展示而非讲述 | 代码示例 > 解释说明 |
| 渐进式披露 | 目录 + 详细内容分文件存放 |
禁止模式
# 填充词 - 禁止使用
simplement, il suffit de, en fait, basically, just, simply,
it's important to note, as mentioned, obviously, of course,
please note that, keep in mind, remember that
# 冗余结构 - 禁止使用
"此文件包含..."（文件名已说明）
"在本节中我们将..."（直接开始）
"以下示例展示..."（直接展示）
格式规则
表格优于段落
# 差 - 45 tokens
系统支持三种模式：开发模式启用热重载，
生产模式优化性能，测试模式模拟外部服务。
# 好 - 20 tokens
| 模式 | 行为 |
|------|----------|
| dev | 热重载 |
| prod | 性能优化 |
| test | 模拟服务 |
列表优于段落
# 差 - 叙述式
运行项目前，首先确保安装Node.js，
然后使用npm install安装依赖，
最后使用npm run dev启动开发服务器。
# 好 - 可扫描
## 运行
1. 要求：Node.js 18+
2. `npm install`
3. `npm run dev`
代码优于解释
# 差 - 解释说明
创建新用户时，调用createUser函数
并传入包含name和email属性的对象。
# 好 - 直接展示
```ts
createUser({ name: "Jo", email: "jo@x.com" })
## 结构模板
CLAUDE.md / 智能体文档：
```markdown
# 项目名称
## 技术栈
- 前端：React/Vite
- 后端：FastAPI
- 数据库：PostgreSQL
## 命令
| 操作 | 命令 |
|--------|---------|
| 开发 | `npm run dev` |
| 测试 | `npm test` |
| 构建 | `npm run build` |
## 架构
[简要描述，如需详细文档请链接]
## 约定
- [规则1]
- [规则2]
渐进式披露
长文档（>200行）：
# 主文档
## 快速参考
[核心信息在此]
## 详细信息
见 [ARCHITECTURE.md](ARCHITECTURE.md)
见 [API.md](API.md)
自检清单
完成前检查：
- [ ] 无填充词？
- [ ] 尽可能使用表格？
- [ ] 使用列表而非段落？
- [ ] 示例优于解释？
- [ ] < 500行（或已拆分）？
- [ ] 无冗余信息？
示例
见 patterns.md 查看前后对比示例。