构建内部知识库的一点心得
最开始想到的是选什么产品、怎么部署。实际做起来后才发现,平台反而可以往后放。更需要先想清楚的是:现有资料能不能用,缺失的资料怎么补,以及这个知识库究竟给谁使用。
一、内网数据决定了知识库的建设方式
有些项目的业务数据和代码都在内网,受安全要求限制,不能传到外部。这类项目使用乐享等需要联网的知识库产品并不方便,也容易带来数据安全问题。
一种解决方式是私有化部署 Dify,把文档、数据和模型调用都留在内部环境中。
不过,私有化部署需要准备服务器、模型、向量数据库,还要处理权限和后续维护。对于刚开始建设知识库的团队来说,这些工作可能比整理知识本身还费时间。
因此,工具选型需要结合项目实际情况。知识库规模较大、使用人数较多时,可以考虑 Dify 这类完整的平台。知识主要服务开发人员时,还有更轻的做法,后面会具体说到。
二、业务文档缺失,可以从代码中找回来
很多运行多年的项目都有类似问题:代码还在,系统也能正常使用,但早期的需求文档、设计文档已经找不到了。
这会直接影响知识库的质量。知识库里没有足够的信息,AI 自然无法给出准确回答。
遇到这种情况,可以从业务代码中提取功能逻辑,重新整理成说明文档。至少在系统当前如何运行这件事上,代码通常是最完整、最准确的信息来源。
这里说的提取,并不是简单地把代码注释复制出来,而是把代码逻辑翻译成更容易理解的功能说明。比如:
这个模块负责什么业务 功能从哪里进入 一次操作会经过哪些步骤 中间有哪些判断条件 会产生哪些状态变化 异常情况如何处理 使用了哪些数据 与其他模块有什么关系
整理完成后,一个原本只能靠人读代码才能理解的业务模块,就有了一份相对完整的功能说明。新接手项目的人可以先看文档,再进入代码,理解成本会低很多。AI 也能根据这些内容回答更具体的问题。
当然,代码主要记录系统如何执行,部分业务背景和设计原因未必能从代码中找到。对于这部分内容,可以请熟悉业务的人补充。暂时无法确认的地方,也可以明确标记出来。
三、功能模块文档和关联说明需要配合使用
一个大型项目通常包含多个业务模块。单独整理每个模块,只能解决局部理解问题。AI 知道某个功能怎么运行,却未必知道它在整个业务流程中处于什么位置。
我比较倾向于把文档分成两层。
第一层是功能模块说明。每个模块单独整理,把业务规则、处理流程、数据变化和异常情况写清楚。
第二层是模块关联和使用指南。它负责说明各个模块之间的关系,以及一次完整的业务操作会经过哪些模块。
比如,订单创建之后会进入哪个模块,库存什么时候扣减,审批结果如何影响订单状态,结算数据从哪里产生。把这些关系串起来之后,AI 才能理解整个业务链路。
有了这两层内容,查询某个功能时可以看模块说明,查询跨模块流程时可以看关联指南。文档之间各有分…