介绍

7 months ago

b11ea29

📘 新一代版本化文档系统

让文档像代码一样可演进、可维护、可协作

我们打造了一套面向 团队 / 企业 / 开源项目 的文档系统，专注解决传统文档在版本管理、多人协作、长期维护上的痛点。

它不仅是“写文档的地方”，而是一个可持续演进的知识基础设施。

🌍 核心理念

文档不是一次性内容，而是随产品持续演进的资产

因此我们引入了：

文档级版本管理
文章级独立版本
类 Git 的 Diff / 派生能力
面向组织的权限与协作模型

让文档真正适配 软件工程、产品迭代、企业知识沉淀。

能力对比

1️⃣ 版本管理能力（决定上限）

能力	木雷文档	Read the Docs	GitBook	Confluence
文档级版本	✅ 原生	⚠️ 基于 Git tag	❌	❌
多版本并行	✅	⚠️ 勉强	❌	❌
版本派生	✅	❌	❌	❌
文章级独立版本	✅	❌	❌	❌
发布 / 冻结版本	✅	⚠️	❌	❌

📌 结论：

唯一“把版本当一等公民”的产品。

2️⃣ Diff / 审计 / 可追溯性

能力	木雷文档	Read the Docs	GitBook	Confluence
文章 Diff	✅ 类 Git	❌	❌	⚠️ 简版
修改审计	✅	⚠️ Git 层	❌	⚠️
发布记录	✅	⚠️	❌	❌
责任人	✅	⚠️	❌	⚠️

3️⃣ 协作模型

维度	木雷文档	Confluence	GitBook	Read the Docs
组织模型	✅ 原生	⚠️	⚠️	❌
权限继承	✅	⚠️	❌	❌
版本级权限	✅	❌	❌	❌
私有 / 公开并存	✅	✅	⚠️	⚠️

4️⃣ 工程友好度

能力	木雷文档	Read the Docs	GitBook	Confluence
工程术语一致性	✅	⚠️	⚠️	❌
版本上下文	✅ 强制	⚠️	❌	❌
并行维护	✅	⚠️	❌	❌
适合 API / SDK	✅	✅	⚠️	❌

✨ 核心能力一览

📚 文档与文章的层级结构

一个组织可维护多本文档
一本「文档」由多篇「文章」组成
支持标签、分类、搜索

适合：

产品文档
技术文档
API 文档
内部知识库

🧩 强大的版本管理能力（区别于传统文档系统）

文档级版本

每本文档拥有清晰的版本线（如 v1.0 / v1.1 / v2.0）
支持：
- 基于任意版本派生新版本
- 多版本并行维护
- 发布版本 / 冻结版本

文章级版本

每篇文章独立版本号
默认展示最新版本
支持历史版本回溯

非常适合「维护旧版本文档，同时开发新版本」的场景。

🔍 Diff / 版本对比（工程级体验）

支持文章内容差异对比
高亮新增 / 删除 / 修改
为评审、回溯、发布提供依据

让文档的修改可追踪、可审计。

🏷️ 完整的发布状态体系

每篇文章具备明确状态：

📝 草稿（Draft）
✅ 已发布（Published）
🗑️ 已废弃（Deprecated）

不同版本、不同状态可独立管理，避免误用过期内容。

🏢 面向组织的协作模型

组织（Organization）

用户可创建或加入多个组织
文档归属于组织

权限体系

所有者 / 管理员 / 维护者 / 成员 / 访客
权限可继承到文档、版本、文章
支持公开文档 & 私有文档

非常适合：

企业团队
开源社区
多项目协作

🚀 现代化的阅读与编辑体验

阅读体验

版本快速切换
左侧目录 + 右侧内容
支持公开访问 & SEO 友好

编辑体验

Markdown / 富文本
草稿与发布分离
版本感知的编辑上下文

🧠 适合哪些场景？

✅ 软件产品文档
✅ API / SDK 文档
✅ 开源项目文档
✅ 企业内部知识库
✅ 多版本长期维护文档

如果你曾遇到：

文档版本混乱
旧版本没人敢删
新版本上线文档跟不上
👉 这套系统正是为你设计的。

🆚 与传统文档系统的差异

能力	本系统	传统文档
文档级版本	✅	❌
多版本并行	✅	❌
版本派生	✅	❌
Diff 对比	✅	❌
工程化思维	✅	❌

🌱 我们的目标

让文档像代码一样被严肃对待

有版本
有历史
可回滚
可对比
可长期维护