How this was built

This builder turns a style guide template into a tool. Answer the questionnaire, and it assembles a style guide for your team's internal docs.

Content is data, not code

Every section of the template and every question in the questionnaire lives in a public GitHub repository, katmoody/style-guide-content, as plain Markdown and YAML. The builder reads that repository live. If GitHub is ever unavailable, it falls back to a built-in copy, so it always works.

A docs-as-code workflow

  1. I write and edit in Obsidian.
  2. When a change is ready, I sync it to GitHub. That sync is my "publish" button.
  3. The builder picks up the change automatically. No code changes, no rebuild.

The questionnaire is structured data

All 40 questions (76 form fields) live in one YAML file. Each answer is tagged with the template section it customizes, and every customizable rule in the template names the question that decides it. That's how the builder knows which answers to show next to which rules.

Decisions behind the design

  • Plain language first. Every rule leads with what to do, then names the grammar term, then shows an example.
  • Made to be adapted. Recommended defaults for every choice, so a team can ship a first version in an hour and improve it later.
  • Accessible by design. A tool about accessible docs should be accessible itself. It's built and tested against WCAG 2.2 AA.

About

Built by Katrina Moody, a technical writer and editor. The template and questionnaire are licensed CC BY-SA 4.0.