VD VibeDocs
EN 中文
Quickstart

Go from zero docs system to first audit in minutes.

This path is intentionally short. Use it to get a Minimal system running before you activate more documents or team-specific rules.

1

Install the package

Use the public npm package. The CLI binary is exposed as vibedocs.

npm install @leapx-ai/vibedocs
2

Initialize a docs system

Start with Minimal unless you already know you need Standard or Full.

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

Generate a feature package

Use feature packages for scoped work that needs its own PRD, tech spec, and acceptance criteria.

npx vibedocs feature create focus-mode
4

Run your first audit

Start with a full repository scan, then use diff mode as part of daily work.

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

Check terminology drift

Run targeted glossary checks when product, feature, or content language starts to diverge.

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

The eight baseline documents

Governance

  • docs/governance/PROJECT-CONSTITUTION.md
  • docs/governance/DOCUMENT-MAP.md
  • docs/governance/GLOSSARY.md

Strategy, product, delivery

  • docs/strategy/PRODUCT-PRINCIPLES.md
  • docs/strategy/ROADMAP-STATUS.md
  • docs/product/FEATURE-PRD.md
  • docs/engineering/TECH-SPEC.md
  • docs/delivery/ACCEPTANCE-CHECKLIST.md
Next

Once the baseline exists, keep audit in your everyday loop.

Initialization is only the first step. Run audit and glossary check regularly so the documentation keeps pace with the codebase and product language.