· 8 分钟阅读

一天搞定一个团队技术文档中心

AI VitePress 团队协作 文档管理

作为一名研发同事,我们的日常工作往往被各种文档、会议纪要、发版记录、会议链接所包围。这些信息散落在企业微信群、飞书文档、Coding Wiki 等各处,随着时间推移,找一个历史会议的录屏或某次发版的技术方案往往需要翻找半天。

今天,我决定借助 AI 助手,用一天的时间从零搭建一个属于我们团队的技术文档中心。以下是整个过程的实录。


一、为什么要建文档中心?

在开始之前,我梳理了团队面临的几个核心痛点:

痛点一:信息孤岛。 项目资产散落在企业微信、飞书、Coding 等多个平台,新人入职难以快速上手。

痛点二:会议无追溯。 每天多个会议的内容、待办事项缺乏统一记录,往往开完会就忘。

痛点三:发版无档案。 生产环境的发版记录、技术方案、自测记录没有统一归档,出了问题难以快速定位。

痛点四:知识无沉淀。 团队的技术经验、业务理解分散在个人脑海里,无法形成组织资产。

解决方案很明确:用 VitePress 搭建一个统一的技术文档站点,把所有信息集中管理。


二、技术选型与架构设计

选择 VitePress 作为文档框架,主要基于以下考量:

轻量级。 基于 Vue 3 + Vite 构建,构建快、部署简单,单页应用性能优秀。

内容优先。 原生支持 Markdown 写作,与开发者的日常工作流完美契合。

导航灵活。 支持多层级 Sidebar、自动生成导航、全文搜索,适合多项目场景。

站点整体架构分为四大模块:

模块一:项目文档

按项目维度组织,每个项目下包含项目介绍、项目资产、生产发版、技术巡检等子模块。目前已接入四个项目:

营销活动中心: xx集团液奶物码营销平台,承载 F-B-b-C 模式下营销活动全流程管理,包含 38 个 K8s 服务的资源巡检记录。

券中心: 优惠券业务技术平台,覆盖券的创建、发放、核销、结算等全生命周期管理。

研盾平台: AI 驱动的研发标准化治理平台,通过三大 AI 智能体覆盖技术方案评审、工时评估、代码走查全流程。

AI 训练营: xx集团 Agent 训练营项目,含 Dify 平台搭建文档与场景实操设计交付物。

模块二:工作日志

按日期组织,记录每天的会议内容、小结和待办事项。每篇日志包含会议信息(时间、发起人、会议号)、讨论内容和行动项。今天一天就记录了 4 场会议的完整内容。

模块三:技术架构

系统架构图的可视化展示,包含服务拓扑、技术栈、部署架构等关键信息。

模块四:首页

站点入口,展示各项目的核心能力和快捷导航,让新成员能在 30 秒内了解团队的全貌。


三、实战过程:AI 助手如何加速开发

整个搭建过程中,AI 助手扮演了”全栈开发助手”的角色,我只需要描述需求,AI 就能完成具体的实现。以下是几个典型场景:

场景一:图片内容提取

当我上传一张会议截图或文档截图时,AI 能自动识别图片中的文字内容,提取出文档标题、链接、说明等信息,并自动分类到对应的资产表格中。例如,上传一张 PRD 文档链接的截图,AI 会自动识别并添加到”PRD 文档”分类下。

场景二:Excel 数据解析

上传一份服务部署情况的 Excel 文件,AI 能自动解析出 38 个服务的详细信息,包括服务名称、说明、Pod 数量、资源配额、依赖组件、代码仓库等,并自动生成结构化的 Markdown 页面,包含”在用服务”和”可下线服务”两个分类。

场景三:PDF 文档解析

上传研盾项目的 PRD PDF 文档(多页),AI 能自动提取关键信息,生成完整的项目介绍页面,包括项目背景、产品定位、核心能力、业务目标、版本规划等内容。

场景四:会议纪要结构化

粘贴一段会议内容,AI 能自动识别会议信息、小结和待办事项,生成结构化的 Markdown 文档,包含会议时间、发起人、腾讯会议号等元信息。

场景五:配置与调试

VitePress 的 Sidebar 配置、导航栏配置、页面创建等重复性工作,AI 都能快速完成。当我发现某个页面没有 Sidebar 时,只需描述问题,AI 就能定位到是路径匹配的问题,并自动修复。


四、成果展示

经过一天的开发,文档中心已经具备了完整的功能:

4 个项目文档。 营销活动中心、券中心、研盾、AI 训练营,每个项目都有独立的介绍、资产和发版记录。

38 个服务的资源巡检。 从 Excel 自动解析,区分在用服务和可下线服务,含代码仓库链接。

2 天的工作日志。 记录了 4 场会议的完整内容,含会议信息、小结和待办事项。

2 次发版记录。 营销活动中心 4/22、4/24 两次发版,券中心 4/27 发版,含技术方案和自测记录链接。

Git 版本管理。 所有变更通过 Git 提交,配合规范的 commit message,支持团队协作。


五、一些心得体会

1. “先有,再优化”的原则

不要试图一次性设计出完美的结构。我的做法是先把内容填充进去,然后根据实际使用体验反复调整。比如表格列的顺序、分类的命名、菜单的层级,都是在使用过程中逐步优化的。

2. AI 是加速器,不是替代品

AI 能很快地完成重复性工作,但关键的业务决策仍然需要人来做。比如文档应该分类到哪个表格、哪些信息需要展示、链接是否正确,这些都需要人工审核。

3. 小步快跑,频繁交付

每完成一个小功能就提交一次 Git,这样既能保持版本可追溯,也能让团队成员及时看到最新变更。

4. 标准化是文档站点的生命线

统一的表格格式(名称、说明、添加时间)、统一的分类结构(文件记录、PRD、开发文档、测试文档等)、统一的命名规范,这些看似琐碎的约定,才是让文档站点能够长期维护的关键。


六、后续规划

文档中心的搭建只是第一步,后续还有很多可以优化的方向:

内容持续沉淀。 将更多项目的技术方案、架构设计、最佳实践等内容补充进去。

搜索体验优化。 接入全文搜索功能,让信息检索更加便捷。

自动化录入。 探索通过 AI 自动录入会议内容的可能性,进一步降低维护成本。

团队协作。 通过 Git 协作,让团队每个成员都能参与文档的维护和更新。


如果你也在为团队知识管理而苦恼,不妨也试试用 AI 助手搭建一个属于你们团队的文档中心。只需要一天,你就能看到成果。