docs-ssot

docs-ssot: Documentation SSOT Setup

This skill migrates existing Markdown documentation into a modular Single Source of Truth (SSOT) structure managed by docs-ssot, then builds and validates the output.

When to use this skill

• Setting up docs-ssot in a new or existing repository (follow the main Workflow)
• Adding a new generated output file (e.g., SETUP.md) to an existing SSOT structure (follow Adding a new output file)
• Regenerating documentation after editing source templates (run docs-ssot build)

---

Quick Command Reference

Command	Purpose
docs-ssot migrate <files>	Decompose existing docs into SSOT section structure
docs-ssot migrate --dry-run <files>	Preview migration without writing files
docs-ssot validate	Dry-run: check all includes resolve (no files written)
docs-ssot build	Generate all output files from templates
docs-ssot check	Detect near-duplicate sections (SSOT violations)
docs-ssot index	Show include relationships and orphan detection
docs-ssot include <template>	Expand and print a template to stdout (debugging)

---

Workflow

Step 1 — Check prerequisites

Verify required tools are installed:

docs-ssot version   # docs-ssot itself
jq --version        # required by the generated-file protection hook
yq --version        # required by the generated-file protection hook and lefthook check

Install docs-ssot if missing:

# Homebrew (macOS/Linux)
brew tap hiromaily/tap && brew install docs-ssot

# or Go install
go install github.com/hiromaily/docs-ssot/cmd/docs-ssot@latest

---

Step 2 — Check if already migrated

Before running migration, check whether this repository already has a docs-ssot structure:

ls docsgen.yaml 2>/dev/null
ls template/sections/ 2>/dev/null

If both exist, the repository is already (partially or fully) migrated. Do not run docs-ssot migrate on generated output files. Instead, skip to Step 5 to review the structure, or Step 8 to validate the current state.