概念

只要几条规则,文档就能保持可用。

VibeDocs 把文档看成项目基础设施。核心关注的是文档角色、生命周期阶段、术语纪律和明确所有权。

结构

文档角色 × 生命周期矩阵

文档不只是按主题归档,而是按角色职责和生命周期阶段组织。这样才能避免所有信息都挤进一层目录。

所有权

SSOT 必须显式声明

状态、范围、规则等共享信息必须指定单一事实源。否则多个文档同时维护,漂移几乎是必然结果。

执行

规则语义只能有一份

本地 CLI、PR 检查和自动巡检可以有不同执行场景,但不应该有不同规则含义。

核心判断

这些文件背后的模型

Minimal 是产品决策,不是妥协

Minimal 起步包不是“文档少一点”,而是让团队和 AI 代理都能共享可靠上下文的最小可用系统。

功能包用来隔离局部复杂度

不是所有改动都应该回写到全局文档。复杂功能应该先在自己的 package 内建立上下文,再决定哪些内容提升为全局 SSOT。

Diff 模式是工作流化的桥梁

diff-aware audit 会基于代码变更给出建议更新的文档触点,减少“该改哪份文档”这种猜测成本。

公开文档必须经过筛选

公开站点应该解释产品和使用方式,而不是把内部计划和原始推演原样暴露出去。