Skip to main content

Documentation Style Guide

Voice​

Use clear, direct language. Prefer task-focused explanations over marketing language.

Page Structure​

Start each page with front matter, one H1, a short purpose statement, and the workflow or reference material the reader needs.

Required Sections​

User workflow pages should include:

  • Purpose
  • Prerequisites
  • Workflow
  • Troubleshooting
  • Related Docs

Technical reference pages should include:

  • Purpose
  • Source of truth
  • Interfaces or commands
  • Operational notes
  • Related Docs

Terminology​

Use the terms from the glossary. Do not introduce synonyms for tenant, template, extraction, classification, platform token, redirect code, or API key unless the glossary is updated.

Use relative links between docs pages. Run the Docusaurus build before publishing documentation changes.