用途:为 Home Assistant 文档、网站页面、集成页面、博客文章和界面说明等面向用户的文字提供统一写作风格。
主要能力与要求:面向全球读者,假设读者主要使用界面,把界面作为标准且推荐的设置与管理方式,将 YAML、模板和手动编辑视为可选路径。语气应体现欢迎、坦诚、支持、慷慨和独立,直接称呼读者为 you/your,使用美式英语并遵循 Microsoft 写作风格指南,使用包容、客观、非歧视的语言。
语言规则:使用牛津逗号;句末加句号且句号后不加两个空格;Markdown 正文自然换行;不用全大写强调,斜体仅用于强调,粗体用于界面字符串;界面路径写作 Settings > Devices & services;完整写 Home Assistant,不用 HA 或 HASS;标题用句首大写;不用 e.g.、i.e.、etc.,改用 like、for example、such as;优先用 select 而非 click;避免 master/slave,改用 client/server 等;品牌、服务、协议名称按官方大小写,如 Z-Wave。
列表与结构:列表前后留空行;顺序步骤用编号列表,非顺序项用项目符号;列表项首字母大写;不在列表项末尾用分号、逗号或 and/or;若有一项为完整句子则所有项加句号,否则不加。页面以简短概述开头,先基础后复杂,用清晰标题分段,优先列表而非表格,仅在有助于查找且不损害清晰度时使用 SEO、LLMO、GEO 与内链。
集成内容:可从界面设置的集成先写界面路径,适用时包含 {% include integrations/config_flow.md %},以 source/_integrations/_integration_docs_template.markdown 为起点,保持模板结构,触发器、条件、动作分别放在 source/_triggers、source/_conditions、source/_actions 下并引入。创建或大幅更新集成文档时使用 document-integration-docs。
弃用与其它:功能弃用或集成移除时删除相关文档,不添加弃用提示;重命名集成或平台时同步更新文档;重命名或移动页面时在 _redirects 添加条目;博客作者须存在于 source/_data/people.yml。不要自行编造仪表板、卡片、自动化或脚本示例,仅可做澄清、注释或小幅简化。
限制:资料未提供具体安装命令、收费信息或平台支持范围。