Находятся ли ваши педагогические навыки на том же уровне, что и ваши навыки программирования?
В большинстве случаев взаимное обучение не является основным источником информации. Развитие бывает разным. В отрасли, где информация портится быстрее, чем клубника, обучение является неотъемлемой частью работы.
Ну не только учёба. Разработчики также тратят значительную часть своего времени на обучение других, будь то неформально (например, Stack Overflow) или в формальной учебной среде (например, Udemy, Zentorial).
После исследования, проведенного с более чем 100 разработчиками и инструкторами по программированию на разных платформах, мы составили 10 принципов, определяющих эффективность учебных материалов.
Следуя этим принципам в своих уроках, вы:
- Обеспечьте более эффективное и последовательное обучение
- Упростите процесс создания и улучшения вашего содержания
Давайте начнем!
1. Принцип прозрачности
Скажите людям, чего именно ожидать от вашего учебника. Начните с того, что расскажите своим читателям, что они узнают, когда закончат, а чего не станут (но, возможно, ожидайте). Сделайте это с помощью пуль и будьте конкретны:
К концу этого руководства вы научитесь:
- Как интегрировать Stripe Checkout в ваше приложение Meteor с помощью пакета NPM
- Как создать простую в управлении базу данных продуктов с помощью MongoDB
Это руководство не научит вас:
- Внедрение подписок Stripe или решений для торговых площадок
- Разрешение споров и возмещение
Помните: ваше руководство должно преследовать единственную главную цель, возможно, с несколькими второстепенными задачами, которые необходимы для ее достижения. Если у вас более 4–5 пунктов в этом списке, возможно, вы направляетесь к монолитным джунглям контента, поэтому, возможно, подумайте о создании серии небольших руководств.
2. Принцип слепоты.
Люди лучше узнают, когда знают, куда они направляются. Разделите свое содержание на главы и добавьте к ним краткую ссылку в начале. Делай это так:
В этом руководстве мы создадим интернет-магазин на Meteor. Вот как это будет работать. Мы:
- Запустите проект и настройте среду разработки.
- Создайте интерфейсную основу (HTML, CSS и JS).
- Создайте базовую внутреннюю структуру (коллекции, публикации, методы).
- Интегрируйте NPM-пакет Stripe (на стороне сервера) и клиентский JS.
- Создайте схему управления платежами и продуктами
Помните: некоторые из ваших читателей могут искать только определенную часть содержания, поэтому, делая это, вы помогаете им найти ее и понять, что было сделано ранее.
3. Принцип топографии
Не позволяйте читателям потеряться. Если ваше руководство включает проект, представьте файловую структуру (в виде дерева папок и файлов) в начале. Кроме того, когда вы показываете или упоминаете код, всегда четко указывайте, в каком файле он расположен (и, если он имеет отношение к вашему контенту, также на сервере или на стороне клиента).
Помните: если люди не могут понять ваше руководство, они зададут дополнительные вопросы. Чем яснее вы будете, тем меньше у вас будет работы в дальнейшем.
4. Принцип новичка
Укажите все предварительные условия. Объясните, что читателю нужно с точки зрения базовых знаний и настройки машины (например, ОС, фреймворков, пакетов, инструментов), чтобы иметь возможность в полной мере использовать преимущества вашего учебника.
Помните: нет ничего очевидного, если вы не упомянули об этом в предварительных требованиях или не объяснили это ранее в руководстве. Если есть что-то, что вы не хотите упоминать в качестве предварительного условия, но и не хотите объяснять, просто не используйте это (например, Promises во многих руководствах по JS).
5. Принцип Каспарова.
Планируйте содержание заранее. Не полагайтесь на импровизацию, независимо от того, какой носитель вы используете (текст, видео, подкаст). Создайте черновик и тщательно спланируйте свой контент, исходя из изначально поставленных целей. Подумайте о последовательности и формулировке. Подтвердите его с потенциальными читателями и / или другими экспертами в данной теме.
Помните: великие идейные лидеры создают у нас впечатление, что они импровизируют, но на самом деле они так хорошо спланировали и изучили свой контент, что достигли нирваны обучение. Это то, чего вы хотите достичь.
6. Принцип именования
Дайте файлам и элементам интуитивно понятные имена. Если вы используете буквы, сокращения (например, res, inp) или пустые слова (например, counter, element), читатели могут забыть или запутаться в том, что они представляют, что приведет к неудовлетворительному опыту обучения.
Помните: повторяющиеся имена - одна из наиболее частых причин недопонимания в учебных пособиях. Даже если две переменные находятся в разных областях (таким образом, конфликта имен не существует), не помешает дать им разные имена.
7. Принцип косой черты
Прокомментируйте свой код. Информация является наиболее полезной, когда предоставляется почти одновременно с ее использованием. Запомни:
- Объяснять элементы (например, переменные, функции), когда они объявлены (или вызваны)
- Кратко объясните шаблонный код (особенно, если вы не будете к нему обращаться позже)
Помните: простой способ определить, является ли ваш код интуитивно понятным и достаточно хорошо задокументированным, - показать его кому-то другому и посмотреть, смогут ли они догадаться, о чем он - как он работает, какие функции он имеет. , как это выглядит.
8. Независимый принцип
Оставьте только строго необходимый код и слова. Удалите весь шум, вызываемый вспомогательными HTML и CSS. Сосредоточьте свои объяснения на основном содержании - на дальнейшие материалы можно ссылаться извне или добавлять в виде сносок. Информация, которая обычно не должна быть частью вашего основного контента:
- История и забавные факты
- Внутренние механизмы, понимание которых не имеет отношения к читателям, на которых вы ориентируетесь (не обсуждайте, как сажать пшеницу на курсе хлебобулочных изделий)
Помните: при написании образовательного контента для профессионалов всегда сосредотачивайтесь на результатах, а не на самой информации. Не спрашивайте себя, чему они хотят научиться. Спросите , что они хотят делать и что им мешает.
9. Принцип перерыва.
Разбейте свой контент на блоки продолжительностью менее 10 минут. Если ваш контент превышает 10 минут, разделите его на две страницы, видео или сообщения. Это облегчает организацию, увеличивает обучаемость и может иметь положительные результаты в привлечении пользователей (люди часто уклоняются от 30-минутных чтений или видео).
Помните: если ваш контент разделен на отдельные блоки (например, разные сообщения или видео), вы должны добавить ссылку на них в начале (помните Принцип № 2?).
10. Принцип юрского периода.
Регулярно обновляйте контент. Не публикуйте и не запускайте. Технический контент быстро устаревает, и актуальность вашего руководства может быть сведена к нулю путем обновления одной версии фреймворка. Лучший способ справиться с этим (особенно если вы часто являетесь автором) - это определить график обновлений и придерживаться его. Добавьте напоминание в свой календарь, чтобы проверить свое руководство через X месяцев.
Помните: во время периодического обновления, даже если вам не нужно было ничего менять, добавьте строку в верхней части учебника с надписью обновлено [новая дата]. Это вызовет большее доверие у читателей и может улучшить SEO. И последнее, но не менее важное: Ответьте на вопросы читателей. Это часть работы.
Помня об этих 10 принципах, будет не только легче создавать учебные материалы, но также будет веселее и полезнее. Написание учебных пособий - это не только отличный способ внести свой вклад в сообщество и выделить свое имя, но также может быть значительным источником пассивного дохода.
Zentorial - это торговая площадка для технических навыков, где вы можете монетизировать свой опыт, публикуя учебные пособия по выбранной вами теме. Вы даже можете начать с предварительно отформатированного руководства, которое позволяет очень легко разместить ваш контент внутри - и следовать 10 принципам.
Хотите написать, но не можете определиться с темой? Отправьте нам сообщение на [email protected], и мы поможем вам с этим :)
Автор: Патрик Нойхаус, руководитель отдела образования Zentorial
