Стандарт учебного материала

Зачем нужен стандарт

Единая структура помогает быстро понять цель материала, подготовиться к работе, повторить ключевые шаги и проверить результат. Не каждая страница обязана содержать все разделы — выбирайте только полезные для темы.

Рекомендуемая структура

1. Короткое описание и контекст.
2. «Что изучим» и конкретные результаты обучения.
3. Предварительные знания и инструменты.
4. Теория, необходимая для задания.
5. Задание и критерии результата.
6. Архитектура решения.
7. Реализация небольшими объяснёнными фрагментами.
8. Частые ошибки.
9. Результат и способ его проверить.
10. Вопросы для самопроверки и самостоятельное задание.
11. Полный исходный код — в сворачиваемом блоке, если он длинный.

Frontmatter

Обязательные поля:

---
title: Понятное название
description: Одно предложение о содержании и пользе страницы.
author: github-login
order: 2
---

Дополнительные метаданные улучшают каталог и статью:

type: practice
tags:
  - Java
  - MVC
difficulty: intermediate
updatedAt: 2026-09-02
estimatedMinutes: 20
status: published

Поддерживаемые типы: theory, practice, notebook, guide, reference. Статусы: draft, published, archived. Черновики не попадают в production manifest.

Код и объяснение

Показывайте ключевой фрагмент рядом с объяснением. Указывайте язык и, когда это помогает, имя файла:

public final class UserController {
    private final User model;
    private final UserView view;
}

Для полного листинга используйте CollapsibleCode, но не скрывайте внутри него части, необходимые для понимания материала.

Callouts

Для коротких уточнений доступны note, tip, warning, info и important:

Самопроверка