返回首页
上一课下一课 →
module4
20 分钟

知识库管理

学习进度

当前模块0/6 课
总进度0/36 课
学习时长0 分钟

学习目标

  • 使用 Codex 搭建 Markdown 知识库
  • 实现文档自动分类与标签
  • 配置全文搜索功能
  • 掌握知识沉淀最佳实践并应用团队模板

305 知识库管理

使用 Codex 构建 Markdown 知识库，实现自动分类、全文搜索和团队知识沉淀

学习目标

一、Markdown 知识库搭建

初始化知识库

# 创建知识库项目
codex kb --init my-team-kb

# 从已有文档导入
codex kb --import docs/

# 从代码仓库提取知识
codex kb --extract-from-code src/

知识库目录结构

my-team-kb/
├── .codex/kb.yaml          # 知识库配置
├── onboarding/             # 新人入职
│   ├── dev-env-setup.md
│   └── team-glossary.md
├── architecture/           # 架构设计
│   ├── system-overview.md
│   └── adr/                # 架构决策记录
├── guides/                 # 操作指南
│   ├── deployment.md
│   └── incident-response.md
├── api/                    # API 文档
└── meetings/               # 会议记录
    └── 2026/
**💡 提示：** 使用 `codex kb --init --template team-standard` 选择预设模板快速启动。

二、自动分类与标签

智能分类

# 对知识库文档自动分类
codex kb --classify

# 为新增文档建议分类位置
codex kb --suggest-category "微服务间通信方案.md"

自动标签生成

# 为所有文档生成标签
codex kb --tag

# 查看标签云
codex kb --tags

Codex 会根据文档内容自动提取：

分类维度示例
技术栈`#python` `#kubernetes` `#postgresql`
文档类型`#guide` `#adr` `#tutorial` `#reference`
团队领域`#auth` `#payments` `#notifications`
阶段`#draft` `#reviewed` `#final`

分类规则配置

`.codex/kb.yaml`：

categories:
  - name: onboarding
    patterns: ["入职", "环境搭建", "账号申请"]
  - name: architecture
    patterns: ["架构", "设计", "ADR", "技术选型"]
  - name: guides
    patterns: ["操作手册", "指南", "部署", "发布"]

tags:
  auto-generate: true
  min-confidence: 0.7
  max-tags-per-doc: 5

三、全文搜索配置

搜索索引构建

# 构建搜索索引
codex kb --index

# 重建索引（文档变更后）
codex kb --reindex

# 搜索知识库
codex kb --search "数据库连接池配置"

搜索功能特性

特性说明
模糊搜索支持拼写错误容忍
语义搜索基于含义而非关键词匹配
过滤搜索按分类、标签、日期筛选
中文分词针对中文文档优化
搜索高亮结果中高亮匹配内容

搜索集成

# 导出搜索 JSON 供前端使用
codex kb --export-search-index --output search-index.json

# 生成静态搜索页面
codex kb --generate-search-page

四、知识沉淀最佳实践

知识生命周期管理

graph LR
    A[草稿] -->|审查| B[已审核]
    B -->|定期检查| C{仍有效?}
    C -->|是| D[归档]
    C -->|否| E[标记过期]
    E -->|更新| A

Codex 辅助命令

# 检查文档新鲜度
codex kb --check-freshness

# 标记过期文档
codex kb --mark-stale --older-than 180d

# 生成知识库健康报告
codex kb --health-report

知识沉淀原则

  1. **即时记录**：会议结束 24 小时内完成会议纪要
  1. **就近存放**：文档放在使用场景最近的位置
  1. **定期更新**：每月检查文档时效性
  1. **责任到人**：每份文档有明确的维护者
**💡 提示：** 配置 `codex cron` 每月自动运行 `codex kb --check-freshness` 并通知文档维护者。

五、团队知识库模板

一键生成

# 生成团队知识库完整模板
codex kb --init --template team-standard my-team-kb

模板内容一览

模块文件说明
快速开始`README.md`团队概览、常用链接
新人指南`onboarding/README.md`入职第一天到第一周
开发规范`guides/coding-standards.md`代码风格、Git 规范
架构文档`architecture/overview.md`系统架构图、技术栈
API 文档`api/README.md`接口清单和使用说明
运维手册`guides/runbook.md`常见问题处理流程
会议模板`meetings/_template.md`标准化会议记录格式

六、本课总结

**核心要点：**

  • `codex kb --init` 一键初始化结构化知识库
  • 自动分类和标签让文档查找效率倍增
  • 语义搜索支持中文分词和模糊匹配
  • 知识生命周期管理防止文档腐化
  • 团队模板统一知识库结构，降低维护成本

**下一步：** 进入最终实战 → [306 实战：搭建内容工作流](module4-306.md)

上一课
下一课