home-assistant-docs-writing-style

Applies Home Assistant documentation style rules when writing or editing user-facing prose.

9.8k|8.5k|Updated Dec 21, 2014
One-click install
npx skills add https://github.com/home-assistant/home-assistant.io --skill home-assistant-docs-writing-style
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: home-assistant-docs-writing-style
Source: https://github.com/home-assistant/home-assistant.io/tree/main/.claude/skills/home-assistant-docs-writing-style
Command: npx skills add https://github.com/home-assistant/home-assistant.io --skill home-assistant-docs-writing-style

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Writing consistent, on-brand documentation for Home Assistant is hard because contributors must follow many style rules covering tone, grammar, UI terminology, list formatting, and integration page structure. This Skill encodes those rules so AI-assisted writing and editing of Home Assistant documentation stays consistent with the official style guide.

Core Features & Use Cases

  • Style enforcement: Applies brand personality, tone, grammar, and terminology rules such as Oxford commas, sentence-style headings, UI breadcrumbs, and correct brand capitalization like "Z-Wave".
  • Integration page structure: Guides creation of integration documentation using the standard template sections, reusable config flow snippets, and separate trigger, condition, and action files.
  • Editorial guardrails: Handles deprecations, page redirects, blog author validation against people.yml, and restrictions on inventing new automation or dashboard examples.
  • Use Case: When drafting a new integration page or editing an existing docs page, the Skill ensures the prose addresses readers as "you", presents the UI as the primary path, and follows the Microsoft Style Guide conventions.

Quick Start

Review and rewrite this Home Assistant integration documentation draft so it follows the official documentation writing style.

Frequently Asked Questions about home-assistant-docs-writing-style

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
What terminology rules apply to Home Assistant documentation?

Always write "Home Assistant" in full, never "HA" or "HASS". Match official brand capitalization such as "Z-Wave", avoid "master/slave" terminology, and use "select" instead of "click" unless describing a mouse action.