Initial commit: company-kb framework
- 完整的知识库框架（P0-P5 路线图） - 12篇治理文档 - 工具脚本（kb-init.sh, kb-lint-fm.py, feishu-sync.py, kb-bot） - 7个 Claude 命令 - 示例项目和测试项目（wanniu-l1） - 契约文件（meta/kb-contract.yaml） Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
This commit is contained in:
yangqianqian
120
README.md
Executable file
120
README.md
Executable file
@@ -0,0 +1,120 @@
|
||||
# 公司 AI 知识库
|
||||
|
||||
> **单一 Git 真相源 + OKF frontmatter + AI 主执行 + 可生长不重做**。
|
||||
> 这个仓库本身就是知识库——没有数据库，没有服务，文件即真相源。Obsidian 编辑、飞书呈现、Claude Code 问答，三个视图共享同一个 Git 仓库。
|
||||
>
|
||||
> 🤖 **AI 快速上手**：读 [`AI-CONTEXT.md`](AI-CONTEXT.md)——全架构蒸馏成一份，读它即掌握整个系统，无需翻 docs。
|
||||
|
||||
---
|
||||
|
||||
## 这是什么
|
||||
|
||||
一个给 5 人小团队用的公司知识库。它把项目决策、聊天沉淀、外部文档汇入到**一个 Git 仓库**里，每页带一段 OKF frontmatter 描述元数据，Claude Code（CC）据此做**可溯源问答**——每条结论都挂原始链接，无据即报 Gap，绝不编造。
|
||||
|
||||
MVP 反过度工程：先做「可溯源 markdown + CC 检索」，编译层（P4）、向量库（P5）按信号延后，默认不上。
|
||||
|
||||
---
|
||||
|
||||
## 怎么用
|
||||
|
||||
### 1. cd 进来问 AI（MVP 默认方式）
|
||||
|
||||
```bash
|
||||
cd ~/奇域/智能体开发/公司AI
|
||||
# 然后直接问 Claude Code：
|
||||
# /kb-ask 客户 A 为什么不用一口价？
|
||||
# /kb-ask power-bid 项目现在进展到哪了？
|
||||
```
|
||||
|
||||
CC 直接语义检索 markdown 回答，每条结论挂 `source_link`。
|
||||
|
||||
### 2. Obsidian 打开当 vault
|
||||
|
||||
直接把 `公司AI/` 目录作为 vault 用 Obsidian 打开，即可 wikilink 跳转、图谱浏览。这是**个人主编辑器**，也是**唯一写路径**（编辑 markdown → `git push`）。
|
||||
|
||||
- 插件清单见 `docs/obsidian-setup.md`（装 Dataview）。
|
||||
- `.obsidian/` 已 gitignore，Git 同步走命令行/CC，不用 Obsidian Git 插件自动提交。
|
||||
|
||||
### 3. 飞书导入
|
||||
|
||||
飞书是**公司呈现面 + 文档来源**，**不直接写**仓库。飞书文档经 `tools/feishu-pull.py` 半自动单向导出流入 `projects/*/docs/`，AI 自动补 frontmatter。凭据走环境变量，不入库。
|
||||
|
||||
### 4. 录入新资料
|
||||
|
||||
```
|
||||
/kb-new <代号> # 建项目骨架
|
||||
/kb-ingest <代号> <源> # 丢资料 + 一句说明 + 对 AI 抽的要点点头
|
||||
/kb-link <文件/NAS路径/URL> # 点名工作目录/NAS/网页的物料，AI 提炼精华+留指针（不搬原件）
|
||||
```
|
||||
|
||||
**人只做**：点名物料 + 一句说明 + 点头。frontmatter 补齐、wikilink、去重全由 AI 自动完成。
|
||||
|
||||
**三条采集通道**：飞书群/文档、NAS 各人投递区（`NAS/<同事>/📥知识库投递/`，AI 只扫这个，私人目录不碰）、`/kb-link` 点名任意文件/链接。默认**不搬原件**——只把 AI 提炼的精华写进库、留 `source_link` 指回原件，库不膨胀、原件移动也不丢知识。
|
||||
|
||||
---
|
||||
|
||||
## AI-native 怎么跑
|
||||
|
||||
四个循环，人是监督者与拍板者：
|
||||
|
||||
- **录入**：人丢资料，AI 去重→落原文→抽要点→写合规页→建 wikilink。矛盾挂起不静默覆盖。
|
||||
- **查询**：CC 检索 markdown，强制溯源，无据报 Gap，绝不编造。
|
||||
- **维护**：`/kb-check` 跑 lint，安全项 AI 自动修，有损项（删/合并/改 type）挂起交人。
|
||||
- **生长**：预留接口，到 P5 红线才启用向量库导航层。
|
||||
|
||||
**铁律**：能让 AI 自动做的绝不让人做（丢资料是唯一强人工入口）；AI 永不擅自有损操作；AI 永不编造。
|
||||
|
||||
详见 `docs/07-AI-native工作流.md`。
|
||||
|
||||
---
|
||||
|
||||
## 文档索引
|
||||
|
||||
| 文档 | 内容 |
|
||||
|---|---|
|
||||
| [docs/01-方案总览.md](docs/01-方案总览.md) | 方案总览 |
|
||||
| [docs/02-首个闭环-项目资料.md](docs/02-首个闭环-项目资料.md) | 首个闭环：项目资料 |
|
||||
| [docs/03-知识库框架选型调研.md](docs/03-知识库框架选型调研.md) | 框架选型调研 |
|
||||
| [docs/04-架构.md](docs/04-架构.md) | 四层架构 + 扁平目录树 + 双前端映射 + 下游接口 + 演进阶梯 |
|
||||
| [docs/05-路线图.md](docs/05-路线图.md) | P0-P5 分阶段作战图，P5 向量库红线 |
|
||||
| [docs/06-工具链.md](docs/06-工具链.md) | 三档工具清单 + gitignore 策略 |
|
||||
| [docs/07-AI-native工作流.md](docs/07-AI-native工作流.md) | 五循环 + 人机分工 + 命令面 |
|
||||
| [docs/08-飞书双向前端方案.md](docs/08-飞书双向前端方案.md) | 飞书双向前端：群机器人（长连接问答）+ 呈现三层架构 |
|
||||
| [docs/09-同事使用指南.md](docs/09-同事使用指南.md) | **面向全体同事**：丢/问/看三动作，零技术门槛 |
|
||||
| [docs/10-部署与运维.md](docs/10-部署与运维.md) | 物理拓扑（NAS Gitea+常驻处理）+ 部署步骤 + 运维手册 |
|
||||
| [docs/11-信息全景与非项目结构.md](docs/11-信息全景与非项目结构.md) | 公司信息全景 + company/learning 结构 + 新类别登记流程 |
|
||||
| [docs/12-治理与规则维护.md](docs/12-治理与规则维护.md) | 规则放哪/谁维护/怎么改：物料全员录入，规则 PR+review |
|
||||
| [CONVENTIONS.md](CONVENTIONS.md) | 录入宪法：frontmatter schema + 命名/wikilink/摄入/lint 规约 |
|
||||
| [docs/obsidian-setup.md](docs/obsidian-setup.md) | Obsidian 共享插件清单 |
|
||||
|
||||
---
|
||||
|
||||
## 单一真相源清单（消除漂移根因）
|
||||
|
||||
| 契约 | 唯一存放处 |
|
||||
|---|---|
|
||||
| type 集 + 字段必填矩阵 + enum | `meta/kb-contract.yaml`（机器可读，lint 运行时读） |
|
||||
| 命令列表 | `docs/07-AI-native工作流.md` + `.claude/commands/` |
|
||||
| 目录布局 | `docs/04-架构.md` |
|
||||
| 溯源锚点 | 每页 `source` / `source_link` |
|
||||
|
||||
任何脚本硬编码 type/字段一律禁止——读契约文件 `meta/kb-contract.yaml`。
|
||||
|
||||
---
|
||||
|
||||
## 目录速览
|
||||
|
||||
```
|
||||
公司AI/
|
||||
├── README.md # 本文（总索引）
|
||||
├── CLAUDE.md # CC 项目级工作记忆
|
||||
├── CONVENTIONS.md # 录入宪法
|
||||
├── docs/ # 01-11 方案文档 + obsidian-setup
|
||||
├── meta/ # kb-contract.yaml（契约）+ stats + ingest-manifest
|
||||
├── projects/ # 项目知识（_example/ 照抄即合规）
|
||||
├── company/ # 公司基本信息（档案/团队/对外介绍）
|
||||
├── learning/ # 共享学习知识库（按领域分：ai/management/industry）
|
||||
├── entities/ concepts/ questions/ # reserved type，按需激活
|
||||
├── tools/ # kb-init.sh / kb-lint-fm.py / feishu-pull.py
|
||||
└── .claude/commands/ # /kb-* 命令
|
||||
```
|
||||
Reference in New Issue
Block a user