Руководство по стилю для создания документации адаптера

Документация создана с использованием языка Markdown.
Хранение файлов документации адаптера регламентируется следующим образом:
- В каждом проекте адаптера есть папка.
  
  /doc.
- Если документация на немецком языке, она будет находиться в подпапке.

de сохранено. В настоящее время поддерживаются языки и, следовательно, имена папок: en, de, ru, pt, nl, fr, it, es, pl.

Актуальная документация адаптера находится в файле README.md,

который находится непосредственно в папке соответствующего языка.
Медиафайлы хранятся в подпапке media, которая также находится в папке

Языковая папка находится.
За исключением README.md, имена файлов и папок пишутся строчными буквами.

Допускаются символы a-z, 0-9, подчеркивание _ и десятичная точка ..

Документы должны иметь разрыв строки длиной 80 символов.
Предпочтительно форматирование текста такое же, как в файле .editorconfig.

описано.
- [Плагин][] для автоматического применения этих правил доступен для
  
  Доступны различные редакторы.
Для немецких текстов требуется соответствие новой немецкой орфографии.

предпочтительнее.
Использование личных местоимений (напр.

«Я», «ты», «мы») следует избегать.
- Используйте гендерно-нейтральные местоимения и существительные во множественном числе.
  - По порядку: «они (несколько)», «их (владение)», «народ»,
    
    «Люди», «Разработчики»
  - Не ОК: «его», «ее», «он», «она (женщина)», «мальчики», «девочки»
Используются ли элементы кронштейнов (все формы кронштейнов и

Кавычки), знаки препинания проставляются следующим образом:
- Внутри скобки, если элемент скобки является цельным.
  
  В предложении есть (подлежащее, сказуемое, дополнение).
- Вне скобок, если элемент скобки является лишь частичным предложением.
  
  содержит.
Документы всегда начинаются с заголовка уровня H1.
Ссылки не размещаются внутри (например, с помощью [ссылка](http://example.com)),

но размещается в конце документа с использованием встроенных [a link][] и [a link]: https://a.link/to/know.

При использовании тире используются сокращенные обозначения.

со знаком минус, а не «—» или Option+Shift+"-" в OSX.
Дополнительный контент:
- Такие документы, как двоичные файлы, изображения, видео- или аудиозаписи,
  
  хранится в папке media.
- Медиа интегрируется в текст для общих файлов

используя §§LLLLL_0§§, а для изображений — ![Медиа-термин](ru/dev/../../de/dev/media/{dateiname}).

Изображения желательно сохранять в формате SVG. Если SVG

невозможно, то в виде PNG-файла. Пожалуйста, следите за размером файла.

Короткие видеоролики можно встроить в формате GIF.
Под каждым изображением приведено краткое описание содержимого, выделенное курсивом.

указать.
Следующее относится к разделам исходного кода:
- В зависимости от языка исходного кода необходимо выбрать соответствующую разметку. Для
  
  Пример \``` для JavaScript.
- Исходный код может, но не обязательно быть полным. Блоки исходного кода

представляют примеры, иллюстрирующие только что описанную точку зрения. Поэтому нет необходимости поставлять полностью исполняемые программы. Если еще необходимо предоставить полностью исполняемую программу, это делается в виде медиафайла в папке media/{code_beispieldatei} с соответствующей ссылкой в документации.

Если используются подчеркивания, кавычки, звездочки или обратная косая черта.

должны быть установлены правильные escape-символы: \_, \*, \\ и \`. anstelle von _, *, \ und `.

*Чтобы особо выделить одно примечание, ниже приведены рекомендации.

отметить:

Идентификатор «Примечание:» должен быть выделен курсивом, т. е. как *Примечание*:.
После идентификатора «Примечание:» продолжайте с заглавной буквы. *Примечание следует размещать в начале нового абзаца так, чтобы оно

лучше видно.
Для документации адаптера существует [шаблон][]. Соответствующие

Разделы шаблона должны использоваться в указанном порядке и форме.