Учебные руководства¶

Учебное руководство — это опыт, который учащийся получает под руководством наставника. Учебное руководство всегда ориентировано на обучение.

Учебное руководство предполагает практическую деятельность: учащийся учится, выполняя осмысленные действия ради достижимой цели.

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

Иными словами, учебное руководство — это урок.

Важно понимать: хотя учащийся учится через действие, то, что он делает, — не обязательно то же самое, чему он учится. Действуя, он приобретает теоретические знания (то есть узнаёт факты), понимание и знакомство с предметом. Он узнаёт, как разные вещи связаны и взаимодействуют между собой и как взаимодействовать с ними; узнаёт названия вещей, учится пользоваться инструментами, осваивает рабочие процессы, понятия, команды и многое другое.

Учебное руководство как урок¶

Урок предполагает отношения между учителем и учеником. При таком обучении ученик учится, когда выполняет задания под руководством преподавателя.

Урок — это учебный опыт. В нём важны действия учащегося и то, что с ним происходит. Объяснения учителя и изложение фактов, напротив, гораздо менее важны.

Хороший урок придаёт учащемуся уверенность: показывает, что он способен овладеть определённым навыком или успешно работать с определённым продуктом.

Обязанности учителя¶

Урок — это своего рода договор между учителем и учеником, в котором почти вся ответственность лежит на учителе. Учитель отвечает за то, чему должен научиться ученик, что тот будет для этого делать и добьётся ли успеха. Единственная обязанность ученика по этому договору — быть внимательным и как можно точнее следовать указаниям учителя. Ученик не несёт ответственности за то, научился ли он, понял ли или запомнил материал.

При этом упражнение, которое вы предлагаете ученикам, должно быть:

осмысленным — ученик должен чувствовать, что чего-то достиг
выполнимым — ученик должен быть способен довести его до конца
логичным — путь ученика должен быть понятным и последовательным
достаточно полным — ученик должен столкнуться со всеми действиями, понятиями и инструментами, с которыми ему необходимо познакомиться

Проблема учебных руководств¶

Учебные руководства редко бывают удачными: отчасти потому, что их и правда трудно делать хорошо, отчасти потому, что сам этот тип документации понимают не вполне верно. У многих программных продуктов нет хороших учебных руководств или нет их вовсе; кроме того, учебные руководства часто смешивают с практическими.

На идеальном уроке учитель присутствует рядом, взаимодействует с учеником и реагирует на его действия, исправляет ошибки и проверяет, как идёт обучение. В документации ничего этого сделать нельзя.

Само по себе нелегко создать учебный опыт, который отвечает всем описанным выше требованиям. К тому же во многих случаях продукт быстро развивается, поэтому всю эту работу приходится повторять, чтобы учебное руководство по-прежнему выполняло свои задачи.

Часто оказывается, что ни одну другую часть документации не приходится перерабатывать так, как учебные руководства. В остальных разделах изменения и улучшения обычно можно вносить изолированно. В учебном руководстве весь путь обучения от начала до конца должен оставаться логичным, поэтому одна правка нередко влечёт изменения во всём повествовании.

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

Ключевые принципы¶

Учебное руководство — это педагогическая задача.

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

И всё же существуют ясные и эффективные способы решать педагогические задачи на практике.

Первое правило преподавания простое: не пытайтесь учить. Ваша задача как учителя — дать учащемуся опыт, который позволит ему научиться. Учитель неизбежно тревожится о том, как передать знания и понимание. Но если поддаться этой тревоге и пытаться учить рассказами и объяснениями, учебный опыт окажется под угрозой.

Вместо этого позвольте обучению состояться и доверьтесь процессу. Дайте учащемуся возможность действовать — и через эти действия он сможет научиться. Учиться способен только сам ученик. Как бы вам этого ни хотелось, вы не сможете научиться за него и не сможете заставить его учиться. Всё, что вы можете, — создать условия, в которых он сможет научиться.

Покажите учащемуся, к чему он придёт¶

Важно с самого начала дать учащемуся представление о том, какого результата он достигнет. Это не только формирует ожидания, но и помогает ему видеть, как по мере работы складывается конечный результат.

Чтобы дать учащемуся нужное представление о результате, иногда достаточно сразу сказать: В этом учебном руководстве мы создадим и развернём масштабируемое веб-приложение. По пути мы познакомимся с инструментами и сервисами контейнеризации.

Это не то же самое, что сказать: В этом учебном руководстве вы научитесь… — такая формулировка самонадеянна и служит крайне неудачным шаблоном.

Показывайте видимые результаты как можно раньше и чаще¶

Учащийся, вероятно, выполняет новые и непривычные действия, смысл которых пока не понимает до конца. Понимание рождается из умения связывать причины со следствиями, поэтому давайте ему возможность быстро и многократно видеть результаты и устанавливать эти связи. Каждый результат должен выглядеть для пользователя осмысленным.

Каждый выполненный учащимся шаг должен давать понятный результат, пусть даже совсем небольшой.

Последовательно описывайте ожидаемое¶

На каждом шаге учебного руководства пользователь на мгновение тревожится: даст ли это действие правильный результат? Поэтому хорошее учебное руководство постоянно подтверждает учащемуся, что тот действительно движется верным путём.

Последовательно описывайте ожидаемое: «Вы заметите, что…»; «Через несколько мгновений сервер ответит…». Покажите пользователю пример фактического вывода или даже точный ожидаемый вывод.

Если вы заранее знаете вероятные признаки ошибки, предупредите о них: «Если в выводе нет…, вероятно, вы забыли…».

Полезно подготовить пользователя к возможным неожиданностям: «Скорее всего, команда выведет в терминал несколько сотен строк журналов».

Обращайте внимание учащегося на важные детали¶

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

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

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

Формируйте чувство действия¶

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

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

Развитие навыка зависит от того, сможет ли учащийся открыть для себя это ощущение и станет ли само действие приносить ему удовольствие.

Ваша задача как автора учебного руководства — связать в заданиях цель и действие так, чтобы они стали основой для этого чувства.

Поощряйте повторение и создавайте для него возможности¶

Учащиеся возвращаются к упражнению, которое удалось выполнить, и повторяют его, потому что им приятно снова получать ожидаемый результат. Так они ещё раз убеждаются, что способны это сделать и что всё работает.

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

Постарайтесь устроить учебное руководство так, чтобы отдельный шаг и его результат можно было повторить. Это бывает трудно, например при необратимых операциях, после которых сложно вернуться к предыдущему шагу, — но создавайте такую возможность везде, где можете. Наблюдая за пользователем, который проходит учебное руководство, вы, возможно, удивитесь, как часто он решает повторить шаг. Он делает это просто для того, чтобы убедиться: то же самое действительно произойдёт снова.

Беспощадно сводите к минимуму объяснения¶

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

Например, вполне достаточно сказать: Мы используем HTTPS, потому что он безопаснее. Подробно обсудить и объяснить HTTPS можно в другом месте, но не сейчас. Дайте ссылку на такое объяснение: оно останется доступным, но не будет мешать.

Учителю особенно трудно удержаться от объяснений. Даже опытным преподавателям непросто принять, что обучение их учеников не зависит от объяснения. Это совершенно естественно. Поняв что-либо, мы осмысляем это для себя с помощью абстракций — и точно так же хотим представить предмет другим. Понять — значит усвоить общие идеи, а абстракция служит логической формой понимания. Однако в учебном руководстве нужно не это, и успешное обучение и преподавание устроены иначе.

Это стоит увидеть своими глазами: сосредоточенное внимание ученика словно растворяется в воздухе, когда учитель своим благонамеренным объяснением разрушает магию обучения.

…и сосредоточьтесь на конкретном¶

Во время обучения ученик живёт текущим моментом, который складывается из конкретных вещей. Вы отвечаете за то, чтобы организовать и поддерживать ход его обучения — переход от одного конкретного действия и результата к следующему.

Сосредоточьтесь на этой задаче, этом действии, этом результате и ведите учащегося от одного конкретного шага к другому.

Может показаться, что, удерживая внимание на конкретном и частном, вы лишаете ученика возможности увидеть или понять более широкие закономерности. На самом деле всё наоборот. Наш ум особенно хорошо умеет находить общие закономерности в конкретных примерах. Любое обучение движется в одном направлении: от конкретного и частного к общему и абстрактному. Второе обязательно вырастет из первого.

Не отвлекайтесь на варианты и альтернативы¶

Ваша задача — привести учащегося к успешному результату. По пути может встретиться множество интересных ответвлений: другие параметры используемой команды, иные способы работы с API или подходы к описываемой задаче. Не отвлекайтесь на них. Ваши указания должны касаться только того, что необходимо для достижения результата, а всё остальное можно оставить на потом.

Так учебное руководство останется короче и яснее, а вам и читателю не придётся выполнять лишнюю умственную работу.

Стремитесь к безупречной надёжности¶

Всё сказанное выше — общие принципы педагогики, однако на авторе учебного руководства лежит особая ответственность.

Учебное руководство должно внушать уверенность. Она складывается слой за слоем, а пошатнуть её очень легко. На каждом этапе, когда вы просите ученика что-то сделать, он должен увидеть обещанный результат. Если учащийся следует вашим указаниям, но не получает ожидаемого результата, он быстро потеряет уверенность в учебном руководстве, наставнике и самом себе.

Учитель, находящийся рядом с учеником, может прийти на помощь, если что-то пойдёт не так. В учебном руководстве такой возможности нет. Оно должно быть устроено настолько хорошо, чтобы ничего не могло пойти не так и чтобы оно работало безотказно — каждый раз и для каждого пользователя.

Создать надёжный учебный опыт трудно, но именно к этому следует стремиться в учебном руководстве.

Как бы тщательно ни было написано учебное руководство, в нём останутся изъяны и пробелы. Самостоятельно обнаружить их все не получится — придётся положиться на пользователей. Узнать о недостатках можно лишь одним способом: путём тщательного тестирования и наблюдения выяснить, что в действительности происходит, когда пользователи проходят учебное руководство.

Язык учебных руководств¶

Мы…: Первое лицо множественного числа подчёркивает связь между наставником и учащимся: вы не одни — мы проходим этот путь вместе.
В этом учебном руководстве мы…: Опишите, какого результата достигнет учащийся.
Сначала сделайте x. Теперь сделайте y. Выполнив y, сделайте z.: Здесь не должно оставаться места для двусмысленности или сомнений.
Мы всегда должны делать x перед y, потому что… (подробнее см. в разделе с объяснением).: Кратко объясните действия как можно более простым языком. Дайте ссылку на подробное объяснение.
Вывод должен выглядеть примерно так…: Дайте учащемуся ясное представление об ожидаемом результате.
Обратите внимание, что… Помните, что… Проверим…: Давайте учащемуся достаточно подсказок, чтобы он мог убедиться, что движется верным путём, и сориентироваться.
Вы создали безопасный трёхслойный гиломорфный стазис-двигатель…: Опишите результат учащегося и слегка им восхититесь.

На примере еды и кулинарии¶

Ребёнок с гордостью показывает блюдо, которое помог приготовить

Тот, кому доводилось учить ребёнка готовить, поймёт, что в учебном руководстве важно, а что — и это не менее важно — совершенно не имеет значения.

На самом деле неважно, что именно приготовит ребёнок и насколько правильно он это сделает. Ценность урока — в том, что получит ребёнок, а не в результате его работы.

Успех кулинарного урока с ребёнком измеряется не качеством блюда и не тем, сможет ли ребёнок теперь самостоятельно повторить весь процесс. Успех — это знания и навыки, которые он приобрёл и которые вы надеялись ему передать.

Важнейшее условие успеха — чтобы ребёнку понравилось находиться с вами на кухне и захотелось вернуться. Навыком невозможно овладеть раз и навсегда: повторение необходимо всегда.

Кулинарный урок может быть построен вокруг приготовления конкретного блюда, однако на самом деле ребёнку, возможно, нужно усвоить другое: перед работой с продуктами мы моем руки; как держать нож; почему масло должно быть горячим; как называется этот кухонный инструмент; как засекать время и отмерять ингредиенты.

Ребёнок осваивает всё это, работая рядом с вами на кухне: постепенно, в собственном темпе и через совместные действия, а не благодаря тому, что вы рассказываете или показываете.

Занимаясь с маленьким ребёнком, вы нередко обнаружите, что урок приходится неожиданно закончить раньше, чем вы успели сделать всё задуманное. Это нормально и ожидаемо: дети не могут долго удерживать внимание. Но если ребёнок сумел чего-то достичь — пусть даже совсем немногого — и получил от этого удовольствие, он уже сделал шаг к практическому мастерству. В следующий раз этот результат можно будет закрепить и развить.