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

Ниже приведены основные требования к оформлению статей документации.

Ссылки

Руководство для участников

Глоссарий терминов

Обзорные страницы

Статья, представляющая раздел, с введением и ссылками на подразделы.

Вводный абзац

Ссылки на разделы с краткими описаниями

Используйте отступ для форматирования каждой ссылки
Ссылка идентична тому, как она отображается в меню.
После ссылки следует длинное тире (пробел-тире-пробел), а затем одно-два предложения, описывающие, как подраздел раскрывает общую тему.

Итоговый абзац связывает раздел с категорией, то есть соотносит тему управления контентом с категорией Управление контентом.

Ссылка на подраздел

Ссылки на подразделы

Заголовки

Регистр заголовка (Title Case)

С заглавной буквы

Первое и последнее слово (всегда)
Существительные, глаголы, прилагательные, наречия
Слова из 4 и более букв (общее правило)

Со строчной буквы

Короткие предлоги: in, on, at, by, for, of, up, to
Артикли: a, an, the
Короткие союзы: and, but, or, nor, so, yet

Пример

A Guide to the Rules of Title Case and How to Use Them

Амперсанд &

Используйте только в меню как замену слову «and», но никогда в заголовках статей.

Пункт меню

6 Pagination & Read More

Заголовок статьи

6 Pagination and Read More

Нумерация

Если содержимое следует нумерованной структуре плана или указателя, не ставьте точку после номера.

Правильно

6 Pagination and Read More

Неправильно

6. Pagination and Read More

Скриншоты

Подробные рекомендации см. в разделе Советы по улучшению скриншотов.

Примечания: ширина 1500–2500 пикселей; светлый (не тёмный) фон браузера; обрезайте изображение так, чтобы сориентировать пользователя и показать нужные детали; используйте масштабирование браузера для увеличения текста; формат файла PNG.

Подписи

При настройке подписи (щёлкните правой кнопкой мыши и отметьте флажок подписи) изображение оборачивается в блок <figure> с соответствующей подписью; в противном случае изображение отображается в стандартном встроенном виде.

Размещение

Размер

Стандартная ширина: 960 пикселей для полной ширины и 320 или 640 пикселей для частичной ширины.

Большие ширины (более 1000 пикселей) автоматически изменяются браузером под ширину статьи. Меньшие изображения выравниваются по левому краю.

Авторство

Если на скриншоте присутствуют изображения, следует ли указывать источник? И каким образом?