快速开始

从零到第一次文档巡检，控制在几分钟内。

这条路径故意压得很短。先把 Minimal 文档系统跑起来，再考虑更完整的文档层级和团队规则扩展。

公共 npm 包会暴露出 vibedocs 这个 CLI 命令。

npm install @leapx-ai/vibedocs

除非你已经明确知道需要更多文档，否则建议从 Minimal 开始。

npx vibedocs init --mode minimal --project-name "Demo" --owner "Berlin"

当一个功能需要独立 PRD、技术说明、验收标准时，直接生成 feature package。

npx vibedocs feature create focus-mode

先做全仓扫描，再把 diff 模式接进日常开发节奏。

npx vibedocs audit --format text
npx vibedocs audit --changed src/app.js --format json

当产品、功能或运营语言开始分叉时，用 glossary check 控制口径一致性。

npx vibedocs glossary check --path docs/product --path docs/features

Minimal 起步包

8 份基线文档

下一步

初始化只是第一步。把 audit 和 glossary check 持续跑起来，文档才能跟代码和产品语言保持同步。