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

Учебник - это опыт, который проходит под руководством репетитора. Учебник всегда ориентированный на обучение.

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

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

Иными словами, урок – это урок.

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

Учебник как урок¶

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

Урок - это опыт обучения. В опыте обучения важно то, что делает ученик и что происходит. Напротив, объяснения и декламации учителя гораздо менее важны.

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

Обязательства учителя¶

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

В то же время упражнение, которое вы выполняете, должно быть:

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

Проблема учебников¶

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

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

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

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

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

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

Учебник - это педагогическая проблема.

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

Тем не менее, существуют простые, эффективные способы решения проблем педагогики на практике.

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

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

Покажите ученику, куда он пойдет¶

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

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

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

Обеспечить видимые результаты рано и часто¶

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

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

Сохранить нарратив ожидаемого¶

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

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

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

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

Укажите, что ученик должен заметить¶

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

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

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

Цель Ощущение делать¶

Во всех навыках или ремесле опытный практик испытывает Чувство делать, объединенную цель, действие, мышление и результат.

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

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

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

Поощрять и разрешать повторение¶

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

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

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

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

Учебник A не место для объяснения. * В учебнике пользователь ориентирован на правильное следование вашим указаниям и получение ожидаемых результатов. *Later, когда они будут готовы, они будут искать объяснения, но прямо сейчас они обеспокоены doing. Объяснение отвлекает их внимание от этого и блокирует их обучение.

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

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

Нужно увидеть это для себя, увидеть, как сосредоточенное внимание ученика растворяется в воздухе, когда благонамеренное объяснение учителя нарушает магическое заклинание обучения.

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

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

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

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

Игнорировать варианты и альтернативы¶

Ваша работа заключается в том, чтобы направить ученика к успешному завершению. По пути может быть много интересных диверсий (различные варианты команды, которую вы используете, разные способы использования API, разные подходы к задаче, которую вы описываете) - игнорируйте их. Ваше руководство должно оставаться сосредоточенным на том, что требуется для достижения результата. и все остальное можно оставить на другое время.

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

Стремитесь к идеальной надежности¶

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

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

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

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

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

Язык учебных пособий¶

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

Применяется к еде и приготовлению пищи¶

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

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

На самом деле не имеет значения, что делает ребенок и насколько правильно он это делает. Ценность урока заключается в том, что получает ребенок, а не в том, что он производит.

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

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

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

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

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