Skip to content

Versioning

How management docs are versioned and where they live.

Folder rule

../nepwalk-docs/docs/management/mvp/v<N>/
  • Major version (v1, v2) = folder.
  • Minor version (v1.1, v1.2) = stays in the same major folder.
  • Create the folder before writing the first doc inside it.

Example:

docs/management/mvp/v1/
  idea_v1.md
  PRD_v1.md
  PRD_v1.1.md     ← same folder
  SRS_v1.md
  SRS_v1.2.md     ← same folder

docs/management/mvp/v2/
  idea_v2.md
  PRD_v2.md

Per-department docs follow the same rule but in their own folder:

../nepwalk-docs/docs/backend/mvp/v1/tasks_v1.md
../nepwalk-docs/docs/frontend/mvp/v1/acceptance_v1.md

Status flow

Status Meaning How to set
draft Just written. Open for edits. Automatic on creation
review Ready for team review. PR open. management: publish <file> or <doc>: promote v<N>
approved Reviewed and merged. Frozen. Reviewer merges the PR

A doc in draft blocks downstream work only if the gate marks it required_before_work. See Prerequisite Gate.

When to bump

  • Minor bump (v1 → v1.1) — content changes, same scope. Use when adding sections, clarifying language, fixing errors.
  • Major bump (v1 → v2) — scope or direction changes materially. Use <doc>_new: or prd_new: etc. Creates a new folder.

Templates

Always start from ../nepwalk-docs/docs/management/templates/<doc>.md. Never invent a structure. Templates are the single source of truth for what sections a doc must have.