Введение должно не раскрывать содержание, а устанавливать пространство, в
котором содержание дальше будет раскрываться. Его задача — не дать сокращённую
версию документа, а поставить читателя в правильную точку входа.
У введения есть функциональная граница:
Введение заканчивается там, где начинается собственно объяснение предмета.
Во введении можно сказать, о чём текст, зачем этот предмет вообще выделять,
какое главное различение или тезис будет удерживаться и где проходит граница
рассмотрения. Но как только текст начинает объяснять механизмы, перечислять
виды, вводить рабочие модели, давать критерии, алгоритмы, классификации или
разбирать случаи, начинается основной материал.
Функции введения
Назвать предмет
Введение должно установить, что именно рассматривается. Недостаточно назвать
тему: необходимо определить объект внимания внутри неё.
Например, формулировка «этот модуль посвящён требованиям» только называет тему.
Хорошее введение показывает, что именно в требованиях является предметом
работы.
Обозначить проблему
Введение показывает, какое смешение, трудность, ошибка или практическая задача
делает тему значимой. Тем самым оно отвечает на вопрос, зачем этому предмету
нужен отдельный текст.
Зафиксировать основной тезис или различение
Обычно достаточно одного, иногда двух тезисов. Введение не должно перечислять
все выводы будущих разделов. Оно задаёт смысловую ось, относительно которой
будет читаться дальнейшее изложение.
Установить границу предмета
Граница нужна только тогда, когда соседние предметы легко смешать и это меняет
объект разговора. Её задача — определить, что считается предметом текста, а не
перечислить всё, чего в тексте не будет.
Например:
В этом модуле под delivery понимается движение изменения до release и
подтверждения его работоспособности.
Такая формулировка задаёт границу понятия и влияет на чтение всего дальнейшего
текста.
Перечень тем, которые не рассматриваются, чаще всего не выполняет этой функции.
Он появляется как защита от возможных неправильных прочтений и заставляет
введение отвечать на воображаемые возражения вместо того, чтобы вводить предмет.
Показать движение текста
Предварительно обозначать маршрут стоит лишь тогда, когда структура достаточно
сложна и читателю действительно полезно знать её заранее. Небольшому материалу
такой обзор часто не нужен.
Введение не обязано представлять эти функции отдельными подзаголовками. Иногда
три последовательных абзаца устанавливают предмет лучше, чем пять служебных
секций.
Постановка и разворачивание предмета
Главная граница проходит между постановкой предмета и его разворачиванием.
Например:
Требование нельзя сводить к формулировке задачи в трекере. Между
бизнес-целью, потребностью, требуемой способностью, выбранным решением и его
реализацией существуют разные уровни. Их смешение приводит к тому, что
команда начинает реализовывать форму решения, не установив, какое изменение
вообще требуется.
Это ещё введение: предмет назван, а проблема обозначена.
Но последовательное объяснение того, на какой вопрос отвечает бизнес-цель, что
означает потребность пользователя и чем является требуемая способность, уже
относится к первому разделу. Здесь начинается обучение конкретному различению.
Другой пример:
Code review позволяет другому инженеру восстановить решение по
реализованному изменению и проверить его до включения в общую кодовую базу.
Эта формулировка устанавливает предмет. Перечень того, что именно reviewer
должен проверить — корректность, читаемость, обработку ошибок, тестируемость и
другие свойства, — уже разворачивает содержание модуля.
Практические проверки
Для каждого абзаца введения можно задать вопрос:
Этот абзац нужен, чтобы понять, что сейчас будет рассматриваться, или он уже
учит тому, как с этим работать?
Если абзац уже учит работе с предметом, он почти наверняка принадлежит основной
части.
Есть и более жёсткая проверка:
Если удалить всё тело документа и оставить только введение, возникнет ли у
читателя ощущение, что он уже получил содержание?
Если да, введение слишком велико. После хорошего введения читатель понимает
вопрос, но ещё не имеет ответа во всех подробностях.
Архитектура текста
Общую конструкцию можно выразить так:
Введение: предмет → проблема → основной тезис → необходимая граница.
Основная часть: различения → механизмы → модели → критерии → практики →
примеры → исключения → следствия.
Заключение: то, что в результате должно удерживаться как целое.
Для больших учебных материалов особенно важно, чтобы введение не проходило
заранее по будущим разделам. Иначе каждый следующий раздел становится вторым
или третьим пересказом уже сказанного.
Итоговый принцип
Граница введения определяется не числом абзацев, а функцией текста. Введение
проводит читателя через дверь, показывает пространство и объясняет, зачем он в
него вошёл. Расстановка предметов и разбор их устройства принадлежат основной
части.
