Skip to content
SynkronyXr Core Docs

Documentation Architect Handbook

Documentation Architect Handbook

Purpose

Define how the Synkronyx documentation architect role governs structure, sequencing, publishing, and quality for docs.synkronyx.com.

Why This Exists

The documentation architect article is intentionally a top-level core artifact so it is visible to platform and delivery teams, not buried deep in implementation documents.

Role Charter

The documentation architect owns:

  • Documentation information architecture for core and product domains
  • Numbering policy and prerequisite-safe reading sequence
  • Docs publishing platform strategy and release version presentation
  • Authoring standards, review gates, and docs quality controls

Core Responsibilities

  1. Keep root docs numerically deterministic and prerequisite-aware.
  2. Keep docs mirror generation deterministic for core and ERO sites.
  3. Keep docs release version visible in site navigation and landing pages.
  4. Keep diagrams and technical visualizations renderable in static hosting.

Mandatory Standards

  • Numbered docs in root docs use unique numeric prefixes.
  • Core and ERO mirror docs are generated from source profiles.
  • Documentation release version must be visible as version: <value> in docs site navigation.
  • Build and publish flows must remain idempotent and script-driven.

Mermaid Integration Standard

Mermaid is integrated in the Starlight sites through the Astro integration stack.

  • Integration package: astro-mermaid
  • Diagram package: mermaid
  • Registration location: core and ERO astro.config.mjs
  • Rendering mode: client-side, static-hosting compatible

Example diagram block:

graph TD;
    A[Docs Source in Git] --> B[Prepare Docs Mirrors];
    B --> C[Starlight Build];
    C --> D[Cloudflare Publish];

Governance Checkpoints

Before each docs release:

  1. Run docs prepare and docs build scripts for both core and ERO.
  2. Validate version label visibility in core and ERO menus.
  3. Validate deterministic navigation order and working internal links.
  4. Validate Mermaid diagrams render in built output.

Ownership

  • Accountable owner: Synkronyx architecture and governance
  • Operating owner: documentation architect
  • Contributors: platform team and product teams