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

• Документация представлена с использованием языкаMarkdown созданный.

• Названия файлов и папок пишутся строчными буквами. Допускаются следующие символы:a-z ,0-9 , нижнее подчеркивание_ а также десятичную точку.

• В документах после 80 символов должен быть перенос строки.

• Желательно, чтобы форматирование текста соответствовало тому, что показано в файле..editorconfig описано. * АPlugin Автоматическое применение этих правил доступно для различных редакторов.

• Для текстов на немецком языке предпочтительно придерживаться новых правил немецкой орфографии.

• В справочных материалах следует избегать использования личных местоимений (например, «я», «ты», «мы»).

• Используйте гендерно-нейтральные местоимения и существительные во множественном числе.

  • Хорошо: "они (несколько)", "их (имущество)", "лица", "люди", "разработчики"
  • Неправильно: "его", "её", "он", "она (женщина)", "мальчики", "девочки"

• При использовании скобок (всех форм скобок и кавычек) знаки препинания расставляются следующим образом:

  • Внутри скобок, если заключенный в скобки элемент содержит полное предложение (подлежащее, сказуемое, дополнение).
  • Вне скобок, если заключенный в скобки элемент содержит только предложение.

• Документы всегда начинаются с заголовка уровня H1.

• Ссылки не размещаются в одной строке (например, с помощью[a link](http://example.com) ), но с помощью встроенного[a link][] и[a link]: https://a.link/to/know размещается в конце документа.

• При использовании тире применяется сокращенная форма со знаком минус, а не «—» илиOption+Shift+"-" в OSX.

• Дополнительное содержимое: * В папке хранятся документы, такие как бинарные файлы, изображения, видео- или аудиозаписи.media Зарегистрировано. * Медиафайлы встраиваются в текст для общих файлов с использованием[Medienbegriff](media/{dateiname}) и для изображений с использованием![Medienbegriff](ru/community/../../de/community/media/{dateiname}) * Изображения желательно сохранять в формате SVG. Если формат SVG недоступен, то в формате JPG или PNG. Пожалуйста, следите за размером файла.

• К разделам исходного кода применяются следующие правила: * В зависимости от языка исходного кода необходимо выбрать соответствующую разметку. Например, ```js для JavaScript. * Исходный код может быть полным, но это необязательно. Блоки исходного кода содержат примеры, иллюстрирующие описываемый момент. Поэтому предоставление полностью функциональных программ не требуется. Если полностью функциональная программа все же необходима, она будет предоставлена в виде медиафайла в папке.media/{code_beispieldatei} с соответствующей ссылкой в документации.

• Если используются подчеркивания, одинарные кавычки, звездочки или обратные косые черты, необходимо вставить соответствующие экранирующие символы:\_ ,\* ,\\ и\` вместо_ ,* ,\ и` .

• Для того чтобы выделить какой-либо момент, следует соблюдать следующие правила:

  • Заголовок "Примечание:" следует выделять курсивом, т. е. следующим образом:*Hinweis*: .
  • После обозначения "Примечание:" следует использовать заглавную букву.
  • Для лучшей видимости примечание следует разместить в начале нового абзаба.

• Документация по адаптеру находится в отдельном разделе.Style Guide .