Rivalry2

HTML Diff

1 added 1 removed

Original 2026-01-01

Modified 2026-02-26

1 Авторов образовательного контента в IT ценят за знания из их профессиональной сферы. Хорошему автору-эксперту нужен разнообразный опыт, широкий стек, глубокое понимание технологий.

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

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

4 <h2>Распутывайте порядок действий</h2>

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

6 Разберем каждый оборот подробнее.

7 <h3>Деепричастия</h3>

8 Они отвечают на вопрос "Что сделав?" или "Что делая?" и обозначают дополнительное действие. Посмотрите на этот пример:

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

10 - Здесь всего один глагол, который указывает на одно действие - "вызвать функцию". Остальные действия скрыты в деепричастиях - "указав", "поместив" и "отделив". На самом деле в предложении упоминается четыре действия, но из-за дееприч��стий студент заметит только одно из них. Из-за этого он может неправильно понять порядок действий.

10 + Здесь всего один глагол, который указывает на одно действие - "вызвать функцию". Остальные действия скрыты в деепричастиях - "указав", "поместив" и "отделив". На самом деле в предложении упоминается четыре действия, но из-за деепричастий студент заметит только одно из них. Из-за этого он может неправильно понять порядок действий.

11 Чтобы студенту было проще проследить последовательность действий, избавимся от деепричастных оборотов и заменим их на глаголы:

12 Чтобы вызвать функцию, укажите после ее имени круглые скобки, поместите в них параметры и отделите их запятой

13 <h3>Причастия</h3>

14 Они похожи на прилагательные - отвечают на вопрос "Какой?". При этом они описывают действие и главного героя в скрытой форме. Например:

15 Параметры функции, не отделенные запятой, приведут к ошибке

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

17 <ul><li>Кто должен отделять параметры запятой?</li>

18 <li>Это происходит автоматически или надо делать это вручную?</li>

19 <li>А если отделить параметры, ошибка произойдет или нет?</li>

20 </ul>Студент может запутаться, что нужно сделать, зачем и в каком порядке. Чтобы упростить мысль, причастный оборот переводим в глагол:

21 Если не отделить параметры функции запятой, то программа выдаст ошибку

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

23 <h2>Меняйте скрытое действие на открытое</h2>

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

25 Рассмотрим такой пример:

26 Я выбежал на лестницу, но врезался в кого-то и упал, в итоге пролетел пару метров и сломал руку

27 Читателю легко представить, что происходило и в каком порядке. В этом предложении очень много глаголов, поэтому в нем чувствуется динамика. Обратите внимание, что в этом примере нет слов "быстро" или "стремительно" - но мы все равно чувствуем, что события происходили быстро и стремительно.

28 А теперь заменим все глаголы действия на отглагольные существительные:

29 Когда я был в процессе быстрого бега по лестнице, произошло столкновение с другим человеком, после которого последовало падение с высоты в пару метров и перелом руки

30 По этому предложению уже сложнее выстроить цепочку событий и прочувствовать динамику. Но есть еще один побочный эффект:

31 <ul><li>В первом примере главный герой - активный участник событий, который действует и несет ответственность за свои действия</li>

32 <li>Во втором примере главный герой - пассивный наблюдатель, который никак не влияет на события вокруг себя</li>

33 </ul>Такой же эффект работает с техническими текстами и уроками. Посмотрим на примере:

34 Параметры - это информация, которая передается в функцию при вызове. На основе этой информации посредством функции происходят вычисления и выдача результата.

35 При создании переменной result интерпретатор получает указание на вызов функции len() и запись возвращенного результата.

36 Одно из постоянных свойств функции - это возврат результата своей работы. Запись len('Hello!') означает вызов функции с именем len() и передачу параметра 'Hello!'.

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

38 Поменяем в нем существительные на глаголы с активным действием:

39 Параметры - это информация, которую мы передаем в функцию во время вызова. На основе этой информации функция вычисляет и выдает результат.

40 Давайте создадим переменную result и укажем интерпретатору: "Вызови функцию len() и запиши результат, который вернется".

41 Функции всегда возвращают результат своей работы. Запись len('Hello!') означает, что мы вызвали функцию с именем len и передали параметр 'Hello!'.

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

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

44 <h2>Показывайте главного героя</h2>

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

46 Эту мысль часто объясняют на таком примере:

47 Уважаемые жители! С 1 января по 31 января в вашем доме будут отключены вода и электричество. Дополнительную информацию об отключении можно получить по телефону +7(900)-000-00-00. Ваши обращения рассматриваются в течение 20 рабочих дней.

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

49 Попробуем заменить все канцелярские формулировки на глаголы действия:

50 Уважаемые жители! Мы решили отключить воду и электричество в вашем доме на весь январь. Если вам это не нравится, позвоните по телефону +7(900)-000-00-00 - мы ответим примерно через месяц.

51 Пример с глаголами стал звучать грубее и честнее - такое объявление точно получит больше возмущенных откликов.

52 Такие приемы встречаются и в образовательных текстах, пусть и не выглядят так критично. Здесь другая проблема - они скрывают от студента важную информацию:

53 Такие формулировки оставляют неясность. У студента может сложиться впечатление, что он не усвоил новые знания из урока.

54 Из этого он может сделать два неверных и неприятных вывода:

55 <ul><li>"Автор сам ничего не знает, и такими формулировками скрыл свои пробелы в знаниях"</li>

56 <li>"Для автора это слишком очевидно, поэтому он выбрал такие формулировки. Скорее всего, дело во мне. Мне никогда не освоить программирование, это слишком сложно"</li>

57 </ul>Чтобы этих выводов избежать, лучше использовать активные глаголы и проговаривать все неочевидные подробности:

58 <ul><li>Не забывайте применять эти правила работы с функциями со стандартными библиотеками</li>

59 <li>Используйте эти правила работы с функциями в стандартных библиотеках. А в нестандартных это уже не требуется, потому что...</li>

60 <li>Эти правила работы с функциями можно использовать в стандартных библиотеках. Это необязательно: без этих правил ваш код тоже будет работать, просто его читаемость будет хуже</li>

61 </ul>Такими формулировками мы дадим студенту самую полную информацию и фундаментальные знания.

62 <h2>Выводы и практические советы</h2>

63 В этом уроке мы изучили некоторые аспекты редактуры, которые часто встречаются в технических и образовательных текстах в IT. Чтобы ваши тексты были понятнее и удобнее для студента, используйте эти приемы:

64 <ul><li>Чаще используйте глаголы действия вместо отглагольных существительных. Таким образом вы нагляднее раскроете тему урока и поддержите мотивацию студента</li>

65 <li>Чаще используйте глаголы вместо прилагательных и причастий. Так вы дадите студенту более ясную инструкцию, и он не запутается в последовательности действий</li>

66 <li>Ищите в своих текстах предложения, в которых неочевиден главный герой. Реже используйте пассивный залог, а также модальные и возвратные глаголы. В таком случае даже новички поймут тему урока во всех деталях</li>

67 </ul>