Напишите статью

Данная документация представляет собой набор файлов Markdown, расположенных в репозитории ioBroker.docs . Каждая страница здесь соответствует ровно одному файлу в этом репозитории. Если вы обнаружили ошибку или хотите что-то добавить, отредактируйте этот файл.

Быстрый способ

Внизу каждой страницы, рядом с датой изменения, находится ссылка « Редактировать на GitHub ». Она ведет непосредственно к файлу, который сгенерировал страницу, и оттуда значок карандаша открывает редактор в браузере. При сохранении GitHub создает ветку и предлагает запрос на слияние (pull request). Для внесения исправлений достаточно учетной записи GitHub; ничего больше не требуется.

Для более масштабных изменений целесообразен обычный подход: создать отдельную ветку репозитория, внести изменения локально и отправить запрос на слияние (pull request).

Какой файл правильный?

Документация доступна на четырех языках по адресу:docs/de ,docs/en ,docs/ru иdocs/zh-cn Источником является только один из них. Это можно определить по заголовку файла:

---
title:       "Reiter Benutzer"
lastChanged: "07.09.2026"
---

Вот как выглядит исходный код. Сгенерированный перевод, с другой стороны, отображает поле.translatedFrom И предупреждение по этому поводу:

---
translatedFrom: de
translatedWarning: If you want to edit this document ...
hash: ...
---

!> Файл сtranslatedFrom Не редактируйте. Файл будет сгенерирован заново при следующем запуске, и изменения будут потеряны. Файл редактируется на том языке, с которого он был переведен.

Регулировать

Обязательные правила изложены в руководстве по стилю . Наиболее важные моменты:

  • Названия файлов только мелким шрифтом.a-z ,0-9 ,_ и. .
  • Перенос строки на отметке 80 символов.
  • Каждый документ начинается с заголовка первого уровня.
  • В справочных текстах не используются личные местоимения, формулировки гендерно-нейтральны.
  • Знак минуса следует использовать как тире, а не как длинное тире.
  • Фотографии и другие вложения находятся в папке.media рядом с боком.

Технические термины остаются в исходном виде. Всё, что в коде, JSON-файле или дереве объектов отображается таким образом, переводиться не будет.state ,role ,button ,level ,string ,callback ,payload Всем, кто ищетlevel. Поиск не находит "Stufen" (уровни). Для разработчиков английский термин всё равно более привычный.

Ситуация иная для терминов, которые пользователь читает на экране: они написаны так же, как и в немецкой версии административной панели, то есть объекты , состояния , категории , протоколы , экземпляры , хосты .

Дополнительную информацию о доступных параметрах разметки, таких как цветные индикаторные поля, можно найти в разделе «Синтаксис Markdown» .

Новые страницы

Одного нового файла недостаточно: страница также должна быть вdocs/content.md Его необходимо ввести, иначе он не появится в меню. Ввод также определяет название на четырех языках:

  * [en:Users;de:Benutzer;ru:Пользователи;zh-cn:用户](admin/users)

Если указано только слово без языкового кода, это относится ко всем языкам.

Что имеет значение с точки зрения содержания?

  • Проверяйте, а не запоминайте. Если на странице описана поверхность, она должна находиться рядом с открытой поверхностью. Надписи меняются.
  • Скажите им, что делать. Список кнопок — это не инструкция. У читателя есть цель.
  • Актуальные изображения. Скриншот старой версии скорее запутает, чем поможет. Лучше вообще не показывать изображение, чем видеть некорректное.
  • Никогда не утверждайте ничего, что не было проверено. Представление предположения как факта приносит больше вреда, чем признание пробела в данных.

Не обязательно писать целую страницу. Исправленная команда, добавленное предложение или актуальное изображение приветствуются.