Skip to content
Kitbay

home-assistant-docs-writing-style

CC-BY-NC-SA-4.0Updated on Nov 11, 202610,152GitHub stars

This skill lives in the repository behind the Home Assistant website and sets the voice for documentation, integration pages, blog posts and interface instructions.

What the skill teaches

This skill lives in the repository behind the Home Assistant website and sets the voice for documentation, integration pages, blog posts and interface instructions. It tells the agent to write for readers who mostly use the graphical interface, to present the UI as the normal way to set things up and to treat YAML, templates and code as optional paths. It describes the project's brand personality, welcoming, candid, supportive, generous and independent, and turns it into concrete rules for tone and wording when an agent drafts or edits user-facing text for the site.

Capabilities

  • Apply Home Assistant's documentation voice and tone
  • Present UI steps before YAML alternatives
  • Edit integration pages and blog prose to the style guide