Оформление статей¶
Пишите так, чтобы читатель мог понять материал без знакомства с остальной вики.
Структура¶
- Короткий и конкретный заголовок.
- Что читатель узнает или сможет сделать.
- Условия и необходимые материалы, если они есть.
- Основное объяснение или последовательность шагов.
- Ожидаемый результат и способ его проверить.
- Источники и связанные статьи.
Основы Markdown¶
# Название статьи
## Раздел
Обычный текст, **важная мысль** и *выделение*.
- Первый пункт
- Второй пункт
[Название ссылки](https://example.com)
Изображения¶
Небольшие изображения можно добавлять в docs/assets/images/. Давайте им понятные названия и заполняйте описание:
Этот относительный путь подходит для статьи в docs/materials/. Для страницы в корне docs/ уберите начальное ../.
Источники и актуальность¶
Ставьте ссылку рядом с утверждением, которое она подтверждает. Если сведения зависят от времени, версии или региона, укажите эти условия и дату проверки.
Большие видео и архивы удобнее хранить отдельно, а в статье давать ссылку. Перед публикацией проверяйте право на использование текста и изображений.