开源文档工具包

让项目更容易被 AI 理解、协作与 持续开发

VibeDocs 用结构化文档、功能包和本地巡检,把零散项目上下文整理成 AI 和团队都能持续依赖的工作底座。

CLI: vibedocs Package: @leapx-ai/vibedocs License: Apache-2.0
核心价值

这套系统最终指向 3 个结果。

目标不只是把文档写出来,而是让项目更容易被理解、更容易协作,也更容易持续开发。

AI 可理解

让需求、决策、结构和状态有稳定上下文

不再依赖临时解释,而是把项目上下文整理成 AI 可以持续读取和复用的结构。

协作可对齐

让团队围绕同一套文档系统工作

不是各自维护一份理解,而是让产品、设计、工程、交付围绕同一套文档持续对齐。

开发可持续

让文档跟着迭代走,而不是上线后就过时

用 feature package 和 audit 把文档维护压进日常开发节奏,而不是等到失真后再补救。

它提供什么能力

一套可以直接放进现有仓库的文档系统。

VibeDocs 尽量贴近普通文件工作流。你不需要迁移到托管平台,也不需要学习新的编辑器。

Templates

可复用的文档起步模板

从治理、产品、工程、交付、运营到功能包,直接复用一套结构明确的文档模板。

Scaffold

可以直接落仓库的目录骨架

通过 Minimal、Standard、Full 三档目录骨架,快速把第一版文档系统生成出来。

CLI

本地初始化与巡检命令

initfeature createauditglossary check 让文档持续可维护。

如何开始使用

第一次跑通,先做这三步就够了。

1. 安装

把公共包装进仓库,使用本地命令开始操作。

npm install @leapx-ai/vibedocs

2. 生成文档

先建一套基线文档,再按真实功能继续扩展。

npx vibedocs init --mode minimal
npx vibedocs feature create focus-mode

3. 保持对齐

把 audit 和 glossary check 变成日常动作,而不是拖到发布前再补。

npx vibedocs audit --changed src/app.js
下一步阅读

第一次跑通看 Quickstart,平时查命令和 schema 看 CLI 与 Reference。

公开站点只保留产品说明和使用方式。需要更细的命令、概念和输出格式时, 继续看 Quickstart、CLI、Concepts、Reference 即可。