LLM Wiki 知识库编译规则 - 通用版本
RULES.md
LLM Wiki 知识库编译规则 - 通用版本
核心原则
1. Raw 层原则
00-待处理(入口层)
- ✅ 零门槛扔文件:无需改名、分类、写说明
- ❌ 不要手动整理:让 LLM 处理
分类文件夹(01-05)
- ✅ 只读追加:不修改、不删除,只新增
- ✅ 时间戳命名:
YYYY-MM-DD-{描述}.{后缀} - ✅ 来源标记:文件开头注明来源
- ❌ 不修改原文:即使有明显错误也保持原样
2. Wiki 层原则
- ✅ 自动生成:所有文档由 LLM 基于 raw 资料编译
- ✅ 可溯源:每个文档标注来源文件
- ✅ 增量更新:只更新相关条目,不重写整个库
- ✅ 冲突标记:观点矛盾时显式标记,不掩盖
- ❌ 人类不直接编辑(除非修正 LLM 错误)
3. 概念创建时机
概念页面需要至少在 2 篇不同来源中被提及,才创建独立页面:
- 第 1 次出现:在摘要中列出,不创建独立页面
- 第 2 次出现:创建独立概念页面
4. 人机分工
| 角色 | 职责 |
|---|---|
| 人类 | 筛选资料、制定规则、审核修改、仲裁冲突、提好问题 |
| LLM | 摘要提炼、概念提取、交叉链接、维护索引、扫描问题 |
核心思想:人类做决策,LLM 做苦力。
5. 冲突处理
- 完全一致:合并信息,更新来源列表
- 有差异但不矛盾:保留两种说法,标注来源差异
- 直接矛盾:明确写出两种观点和来源,不强行统一,由人类仲裁
三步编译法
每次编译任何资料,严格执行:
第一步:浓缩
- 奥卡姆剃刀:删掉不影响理解的冗余信息
- 输出:核心结论(≤ 3 条)+ 关键证据
第二步:质疑
针对每条结论回答:
- 依赖哪些前提假设?
- 前提不成立时结论还成立吗?
- 数据来源可靠吗?
- 有没有反例或边界条件?
第三步:对标
- 其他领域有类似现象吗?
- 知识可迁移到哪些场景?
- 有跨域关联则创建/更新概念条目
目录结构约定
项目根目录/
├── RULES.md # 本文件 - 通用 Schema
├── docs/
│ ├── raw/ # 第一层:原始资料层(人类只往这里扔,不编辑)
│ │ ├── 00-待处理/ # 入口文件夹:直接扔文件,无需命名/分类
│ │ ├── 01-需求讨论/
│ │ ├── 02-会议纪要/
│ │ ├── 03-竞品分析/
│ │ ├── 04-设计原稿/
│ │ └── 05-运营数据/
│ │
│ └── wiki/ # 第二层:编译知识层(LLM 维护,人类只读)
│ ├── summaries/ # 逐篇编译摘要
│ ├── concepts/ # 概念条目(核心知识资产)
│ ├── methods/ # 方法论页面
│ ├── decisions/ # 决策记录(ADR)
│ ├── indexes/ # 索引和日志
│ ├── schema/ # Schema 扩展文档
│ └── tutorials/ # 教程
标准工作流
导入(Ingest) → 编译(Compile) → 查询(Query) → 归档(File) → 体检(Lint)
↑ ↓
└─────────────────────────────────────────────────────────┘
| 步骤 | 人类做什么 | LLM 做什么 |
|---|---|---|
| 导入 | 扔文件到 00-待处理/ | 读取 → 分类 → 重命名 → 补充来源 → 移动 |
| 编译 | 确认文件已归档 | 三步编译 → 更新概念 → 更新索引 |
| 查询 | 提好问题 | 读相关页面 → 综合推理 → 结构化回答 |
| 归档 | 判断回答价值 | 有价值则存为 Wiki 页面 |
| 体检 | 每周一次 | 扫描矛盾、断链、孤岛、缺口 |
技能速查表
| 技能 | 命令 | 说明 | 详细定义 |
|---|---|---|---|
| 导入 | /ingest |
处理待处理文件夹 | ingest.md |
| 编译 | /compile 路径 |
编译单篇文章 | compile.md |
| 增量更新 | /refresh-wiki |
批量编译新文件 | refresh-wiki.md |
| 概念升级 | /upgrade-concepts |
创建独立概念页面 | upgrade-concepts.md |
| 问答 | /wiki 问题 |
查询知识库 | wiki.md |
| 归档问答 | /file-answer |
存回 Wiki | file-answer.md |
| 记录决策 | /decision |
创建 ADR | decision.md |
| 健康检查 | /health |
扫描问题 | health.md |
| 核心理念 | /why-llm-wiki |
解释设计理念 | why-llm-wiki.md |
技能详细说明
技能:导入
命令:/ingest
触发词:
- "处理待处理文件夹"
- "导入新文件"
- "帮我处理 00-待处理 里的文件"
- "有新文件要处理"
- "扫描入口文件夹"
- "刚才扔的文件处理一下"
执行逻辑:
- 扫描
docs/raw/00-待处理/目录 - 读取每个文件内容,判断分类(需求讨论/会议纪要/竞品分析/设计原稿/运营数据)
- 如果来源不明确,询问用户
- 重命名(加日期前缀)并移动到对应分类文件夹
- 在文件开头写入来源标记
- 删除原文件,报告处理结果
详细定义:ingest.md
技能:编译
命令:/compile 文件路径
触发词:
- "编译这篇文章:[路径]"
- "处理这个文件:[路径]"
- "把这篇文章编译进知识库"
- "分析这篇文档"
- "编译 [文件名]"
执行逻辑:
- 读取指定路径的原始文件
- 执行三步编译法(浓缩 → 质疑 → 对标)
- 生成摘要到
docs/wiki/summaries/ - 提取概念,标记为"待观察"(首次出现)或创建独立页面(二次出现)
- 更新
docs/wiki/indexes/index.md和log.md
详细定义:compile.md
技能:增量更新
命令:/refresh-wiki
触发词:
- "批量编译所有新文件"
- "处理所有未编译的文章"
- "更新知识库"
- "编译所有新文章"
- "批量处理"
执行逻辑:
- 扫描
docs/raw/01-05/所有分类文件夹 - 对比
docs/wiki/summaries/,找出未编译的文件 - 按文件日期从早到晚依次编译
- 遇到概念冲突时暂停,询问用户
- 输出处理报告
详细定义:refresh-wiki.md
技能:概念升级
命令:/upgrade-concepts
触发词:
- "升级待观察概念"
- "创建独立概念页面"
- "检查哪些概念达到阈值"
- "批量创建概念"
执行逻辑:
- 扫描所有摘要,统计概念出现次数
- 找出出现 ≥ 2 次但尚未创建独立页面的概念
- 为每个概念创建独立页面到
docs/wiki/concepts/ - 更新相关摘要的关联链接
详细定义:upgrade-concepts.md
技能:问答
命令:/wiki 问题
触发词:
- "查询知识库:[问题]"
- "根据知识库回答:[问题]"
- "知识库里有什么关于 [主题] 的内容"
- "查一下 [问题]"
- 以问号结尾的疑问句(自动推断为查询)
执行逻辑:
- 分析问题,识别关键词和概念
- 读取相关摘要和概念页面
- 综合推理,给出结构化回答
- 标注信息来源
详细定义:wiki.md
技能:归档问答
命令:/file-answer --title "标题"
触发词:
- "归档这个回答"
- "把这个存到知识库"
- "保存刚才的回答"
- "这个回答有价值,存起来"
执行逻辑:
- 提取最近一次问答内容
- 整理成决策记录格式
- 写入
docs/wiki/decisions/ - 更新索引
详细定义:file-answer.md
技能:记录决策
命令:/decision --title "标题"
触发词:
- "记录决策:[标题]"
- "记录这个决定"
- "创建 ADR"
- "我要记录一个架构决策"
- "这个决策需要记录下来"
执行逻辑:
- 询问决策背景、内容、理由、替代方案
- 生成 ADR 格式文档
- 写入
docs/wiki/decisions/ADR-xxx.md - 更新索引
详细定义:decision.md
技能:健康检查
命令:/health
触发词:
- "检查知识库健康状态"
- "体检知识库"
- "扫描知识库问题"
- "检查有没有断链或孤岛"
- "知识库体检"
执行逻辑:
- 断链检查:引用的文件是否存在
- 孤岛检测:概念页面是否被引用
- 定义冲突:不同文章说法是否矛盾
- 来源缺失:文件是否缺少来源标记
- 输出检查报告和修复建议
详细定义:health.md
技能:核心理念
命令:/why-llm-wiki
触发词:
- "解释设计理念"
- "为什么要用这套体系"
- "LLM Wiki 是什么"
- "这套体系的原理是什么"
执行逻辑:
解释三层架构、三步编译法、知识复利、人机分工等核心理念。
详细定义:why-llm-wiki.md
歧义消解规则
当用户意图不明确时,按以下规则推断:
| 用户表述特征 | 推断技能 |
|---|---|
| 提到"00-待处理"、"刚扔了文件"、"入口文件夹" | 导入(Ingest) |
提到具体文件路径(如 docs/raw/01-需求讨论/xxx.md) |
编译(Compile) |
| 以问号结尾或疑问句式 | 问答(Wiki Query) |
| 提到"决策"、"决定"、"ADR" | 记录决策(Decision) |
| 提到"体检"、"检查"、"健康" | 健康检查(Health) |
| 提到"归档"、"保存回答" | 归档问答(File Answer) |
最佳实践清单
✅ 扔文件到 00-待处理/ → 导入 → 编译
✅ 每次只编译一篇文章,质量比速度重要
✅ 积累 3-5 篇后运行概念升级
✅ 每周运行一次健康检查
✅ 不直接编辑 wiki 文件,有新信息就新增 raw 文件
✅ 高质量问答归档回去
扩展文档
| 文档 | 说明 |
|---|---|
docs/wiki/schema/formats.md |
所有文档格式模板 |
docs/wiki/schema/skills.md |
技能详细说明 |
docs/wiki/tutorials/quick-start.md |
快速上手教程 |
工具适配说明
| 工具 | 配置文件 | 说明 |
|---|---|---|
| Claude Code | CLAUDE.md |
自动读取项目根目录 |
| OpenAI Codex | AGENTS.md |
自动读取项目根目录 |
| Cursor | .cursorrules |
自动读取,需精简版 |
| GitHub Copilot | .github/copilot-instructions.md |
自动读取 |
| 其他工具 | 按工具约定 | 引用或复制本文件 |
同步方式
Linux / Mac:
# 符号链接
ln -s RULES.md CLAUDE.md
ln -s RULES.md AGENTS.md
Windows (PowerShell):
# 符号链接(需要管理员权限)
New-Item -ItemType SymbolicLink -Path CLAUDE.md -Target RULES.md
# 或直接复制(推荐)
Copy-Item RULES.md CLAUDE.md
Cursor 注意:.cursorrules 不支持引用语法,需要从 RULES.md 提取精简版本(60 行以内)。
浙公网安备 33010602011771号