Concepts

A few rules keep documentation usable.

VibeDocs treats documentation as working project infrastructure. The model focuses on document roles, lifecycle stages, terminology discipline, and clear ownership.

Structure

Role × lifecycle matrix

Documents are not just grouped by topic. They are organized by the role they play and the lifecycle stage they serve.

Ownership

SSOT is declared, not implied

A document map should name the single source of truth for status, scope, and other shared concerns. Without this, duplication becomes drift.

Operations

Rules belong in one engine

Local audits, PR checks, and future scheduled audits should share the same rule semantics instead of re-implementing checks in each layer.

Core ideas

The model behind the files

Minimal is a product decision

The Minimal set is not “less documentation.” It is the smallest viable system that still allows a team and an AI agent to share reliable context.

Feature packages keep local work local

Not every change belongs in a single monolithic product doc. Feature packages make it cheap to add focused documents without polluting global status or governance files.

Diff-aware audit reduces guesswork

Diff-aware audit helps local work stay grounded. When code changes, suggested docs touchpoints make it easier to update the right files instead of guessing.

Public docs should be curated

A public docs site should explain the product and usage model. It should not mirror an entire internal planning directory.