Index / 15 tools

Uses

The stack I actually work in, not the one that looks good in a talk. If a tool is on this list it has survived at least one real release cycle.

01

Authoring

  • Oxygen XML DITA source, shortdesc and searchtitle discipline
  • VS Code Markdown, AsciiDoc, YAML — plus custom tasks
  • AsciiDoc When Markdown runs out of road
  • Markdown Everything else, including this site
02

API documentation

  • OpenAPI 3.1 The contract everything else derives from
  • Redocly CLI Split, lint, bundle, decorate
  • Redoc / Redocusaurus Reference rendering
  • Swagger Bundling and multi-file reuse
03

Quality gates

  • Vale CLI Style and terminology, run from the editor
  • Custom Python checks Wired in through VS Code tasks
  • Link checking In CI, before merge
  • Git Docs reviewed like code
04

Visual

  • Animated infographics Rendered locally, published as GIF and MP4
  • Diagrams SVG, hand-tuned rather than auto-laid-out
  • ffmpeg Encoding and colour work

Setting up a similar stack and stuck on a piece of it? I have probably broken it before.

Ask me