Меня зовут Дмитрий Руднев. Обычно я пишу в хабы «Электроника для начинающих», «Схемотехника», «DIY или Сделай сам» и некоторые другие. Мне очень нравится просто и понятно писать о разработке радиоэлектронных устройств. Примером в этом для меня служат В.Г. Борисов (автор «Юного радиолюбителя»), В.Т. Поляков (RA3AAE, в представлении не нуждается), Б.Г. Степанов (RU3AX, ex. UW3AX, редактор журнала «Радио»).

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

Что такое «туториал»

Смотрим в разделе «Для авторов»:

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

Ограничения достаточно жёсткие. Ключевые слова: «инструкция», «по шагам», «результат», «никаких вопросов». Хотелось бы ещё добавить: «понятность» и «наглядность».

Написание туториала – серьёзный вызов для профессионала. Только профессионал может писать по делу, кратко, понятно и «без воды».

Живой русский язык

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

Разработка вышеперечисленной текстовой документации должна производиться на основании требований разделов 4.10 «Пояснительная записка» и 4.11 «Программа и методика испытаний» ГОСТ Р 2.106-2019, требований разделов 5 «Руководство по эксплуатации» и 6 «Инструкция по монтажу, пуску, регулированию и обкатке изделия» ГОСТ Р 2.610-2019, требований РД 50-34.698-90 в части описания автоматизированных систем, далее АС.

Разрабатываемые документы должны иметь структуру согласно вышеперечисленным требованиям. Вводная часть должна содержать информацию о назначении документа и актуальности раскрываемой темы. Содержание разделов основной части должно точно соответствовать раскрываемой теме. Изложение материала должно быть сжатым, логичным и не допускать неоднозначных трактовок. Оформление списка используемых источников должно соответствовать требованиям ГОСТ 7.1-2003.

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

Когда я решил начать публиковаться на Хабре, я понял, что должен поменять стиль. Для этого я стал читать статьи из раздела «Радио – начинающим» журнала «Радио», перечитывать «Юного радиолюбителя» Борисова и заново открывать для себя Полякова. Это замечательные образцы того, как можно понятно объяснять сложные вещи. Любителям.

Портрет поколения

Моё становление как радиолюбителя шло на фоне тотального дефицита: необходимость постоянно ремонтировать телевизоры и радиоприёмники; самостоятельное изготовление и наладка любительской радиостанции; самостоятельная сборка усилителей и акустических систем, цветомузыкальных приставок, автоматических определителей номеров и компьютеров ZX Spectrum, наконец. В результате мне пришлось знать и ламповую электронику, и транзисторную, я разбираюсь и в аналоговой электронике, и в дискретной. А ещё я умею пилить, строгать и писать программы на C для микроконтроллеров.

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

Это по любви

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

Профессионалы используют устоявшуюся в их профессиональном сообществе терминологию, любители – изобретают свою. И тогда появляется то, что я называю «хрустальный осциллятор».

«Хрустальный осциллятор» — это, как уже все догадались, «вольный перевод» словосочетания «crystal oscillator». В принципе, понятно, когда знаешь, о чём речь. Вот только «осциллятор» — это из области физики, а в электронике используют «генераторы».

Применение терминологии очень хитрая вещь: «Wien bridge» это «мост Вина», но «Darlington transistor» — не «транзистор Дарлингтона», а «составной транзистор». И так сложилось исторически, что «push-pull output» переводится с английского на русский как «двухтактный выходной каскад».

И сразу видно любителя, когда в туториале описывается тернистый путь автора к очевидному решению из учебника или справочника. Признаюсь, сам в молодости грешил этим, но тогда был дефицит, и найти «Искусство схемотехники» Хоровица и Хилла было очень трудно, практически невозможно. Да и интернета не было…

Опубликованные любителями туториалы могут содержать фактические ошибки, в них могут быть непроверенные решения со спорным обоснованием, но их читают и «плюсуют». Их обсуждают, критикуют в комментариях, предлагают альтернативные решения.

Иногда мне кажется, что плашка «Tutorial» в публикации любителя означает не столько учебный материал, не столько справочное пособие, сколько призыв посмотреть на то, что получилось. А оно получилось! Поэтому там и история о себе, и рассказ о трудностях выбора решения, и о том как перепутал полярность питания и всё сжёг, и о том что китайцы прислали не те комплектующие…

Получается, что все эти «туториалы» – живой рассказ о себе, о своей истории успеха, а не сухая инструкция по ГОСТ.

Окончательно я утвердился в этом мнении, когда несколько лет назад на Хабре был парад публикаций на тему «Как я сделал метеостанцию на Arduino».

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

Субъективное оценочное мнение

Слово «радиолюбитель» составлено из слов «радио» и «любить». Я всецело поддерживаю всё, что объединяет людей. Если увлечённый человек напишет задорный рассказ о том, как он набил себе шишек, изобретая очередной «велосипед», и приклеит к нему плашку «Tutorial», я только порадуюсь за него.

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

Любую свою публикацию я могу превратить в «туториал», переписав её согласно требованиям, и сократив раза в три таким образом. Это будет идеально структурированная инструкция со списком аббревиатур и терминов, ссылками на нормативные документы и внешние источники. Выполнение этой инструкции будет гарантировать результат. Комментаторам останется только выразить благодарность за отлично выполненную работу. Хотелось бы вам побольше таких публикаций?

Мне – совсем не хочется, вот поэтому я и не люблю писать туториалы.