Меня зовут Дмитрий Руднев. Обычно я пишу в хабы «Электроника для начинающих», «Схемотехника», «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 слов на публикацию. Этого объёма хватает, чтобы описать проблему, указать решение и обосновать его.
Любую свою публикацию я могу превратить в «туториал», переписав её согласно требованиям, и сократив раза в три таким образом. Это будет идеально структурированная инструкция со списком аббревиатур и терминов, ссылками на нормативные документы и внешние источники. Выполнение этой инструкции будет гарантировать результат. Комментаторам останется только выразить благодарность за отлично выполненную работу. Хотелось бы вам побольше таких публикаций?
Мне – совсем не хочется, вот поэтому я и не люблю писать туториалы.
- Главная
- Происшествия
Ярослав КУЛИШ
22 декабря 2021 20:17
0
Фото: facebook.com/profile.php?id=100011121947008
С почином. В модной платной камере Лукьяновского СИЗО, которые так рекламирует министр юстиции Денис Малюська, произошло кровопролитие — удар ножом получил предприниматель Максим Кириченко, которого судят за экономические преступления.
Пострадавшего, который получил ножевые ранения со значительной кровопотерей, зовут Максим Кириченко — его судят за совершение экономических преступлений. Подробнее о происшествии «КП в Украине» рассказала адвокат пострадавшего Дарья Шевченко.
Привет от людей, которых обидел
— Во вторник 21 декабря у нас с моим подзащитным в СИЗО была запланирована встреча. Но его обычно долго не приводили — ждешь минут тридцать, а тут пришлось ожидать около двух часов,- начинает рассказ Дарья Шевченко. — И когда я его увидела, сразу все поняла: вся одежда залита кровью, в правой руке катетер, раны на левой руке уже зашиты.
Максим Кириченко находился в СИЗО всего дней десять, но с первого дня просил перевести его в платную камеру за 12 тысяч гривен в месяц.
— Там куча камер свободных, но почему-то долго решали, переводить или не переводить. Наконец именно 20-го числа перевели. Но в камере находился заключенный, который начал предъявлять к моему подзащитному претензии, передавать приветы от каких-то обиженных на Кириченко людей. А затем достал нож и нанес глубокую рану, — говорит наша собеседница. — Сразу же была большая кровопотеря. Разрезано плечо, повреждена вена, связки. 15 минут он истекал кровью.
По ее словам, пострадавшего отвезли в больницу на обычной машине, а не на скорой. Врачи зашили рану, вену шунтировали и вернули в СИЗО. На просьбы Кириченко позвонить родителям или адвокату и сообщить о произошедшем никак не отреагировали.
Предпринимателя Максима Кириченко подозревают в том, что он нанес убыток своей компании на 280 тысяч долларов. Фото: /t.me/+ogVjVYFl-Fg0MjUy
Хотели списать на несчастный случай
Дарья увидела своего клиента лишь на следующий день и смогла с ним обстоятельно поговорить.
— По его словам, его настойчиво попросили подписать заявление, что он сам упал и повредил руку. За это обещали перевести в другую, уже одиночную камеру. Мол, там никто резать не будет и больше такое не повторится, — продолжает Дарья Шевченко. — Сейчас он в одиночной камере, но без медицинской помощи. У него пытаются физически отобрать испачканную одежду, чтобы следов происшествия не осталось.
Адвокат обратилась с жалобой в Шевченковский райотдел, Минюст, департамент исполнения уголовных наказаний. Но…
— В Шевченковском райотделе еще не расписано, кто нами занимается. А это принципиально, потому что нужно осмотреть место происшествия, назначить экспертизу, провести комплекс следственных действий, — объясняет адвокат. -В департаменте исполнения ни одна горячая линия не отвечает. Также и в Минюсте. Даже приехав туда и названивая по 10 разным имеющимся номерам, я лишь случайно попала на человека, который поднял трубку и услышала: «У нас в 4 часа корпоратив, поэтому никто вам помочь не может».
Для того чтобы придать делу огласку, адвокат обратилась в СМИ.
— Получить нормальное лечение мой подопечный не может. Даже получить список обезболивающих и антибиотиков. Никакой квалифицированной медицинской помощи у него нет. Даже если человек наступает на ржавый гвоздь, то без антибиотиков никак. А тут ранение нестерильным ножом ,который неясно как оказался там без ведома администрации, — говорит Дарья Шевченко.
Посадили к матерому сокамернику
По словам нашей собеседницы, сокамерник, который нанес удар ножом, отбывает наказание за совершение тяжких преступлений. И это вызывает вопросы, почему к нему посадили человека без криминального стажа, которого привлекают за экономические преступления.
— Кириченко просто ботаник. Ему инкриминируется экономический характер преступления. И кроме того, я считаю, подозрение у него необоснованное, его вся жизнь до этого события свидетельствует о том, что он не способен даже контактировать со злоумышленниками, — утверждает адвокат Шевченко.
Она настаивает — все произошло не случайно: в СИЗО якобы были свободны другие платные камеры. Человек, ранивший Кириченко, сидел с другим сокамерником, которого перевели перед тем, как туда поселили Кириченко.
— Для меня очевидно — это спланированная акция. И все это уголовное дело в отношении Кириченко выглядит заказным. Наверняка человек, заказавший все это, хотел так передать привет. Мы не знаем, рассчитывал ли он, что будут такие телесные повреждения, — предположила адвокат.
Денис Малюська лично показывал, какие удобные и комфортабельные новые платные камеры. Фото: facebook.com/profile.php?id=100011121947008
Был финдиректором агротрейдинговой компании
До попадания в Лукьяновское СИЗО Максим Кириченко был финансовым директором в агротрейдинговой компании, принадлежащей крупному известному бизнесмену.
— В чем суть претензий к Кириченко: собственник компаний считает, что часть сделок в 2020-21 году были убыточными. И, соответственно, в этом он видит нанесение вреда его компании. Хотя вреда никакого нет, — поясняет адвокат. — Моя задача — обеспечить медицинское наблюдение подзащитному, для этого нужно менять меру пресечения, чтобы Кириченко имел доступ к полноценному лечению и мог получить квалифицированную помощь. Ведь выходит, что даже платные камеры не являются безопасными.
Впрочем, обвиняемый может выйти на свободу, но под залог в 10 миллионов гривен.
— Почему такая сумма- никто не объяснил, — утверждает Дарья Шевченко.
В УПК есть норма, что залог должен составлять от 80 до 300 прожиточных минимумов. Максимальная граница залога 717 тысяч гривен.
— Если следственный судья считает, что случай исключительным, он имеет право выйти за эти рамки. Но для семьи Кириченко даже 717 тысяч — это уже из разряда непосильного. Но это хотя бы в рамках границ, определенных УПК, — продолжает наша собеседница.
Компания, в которой работал Кириченко, понесла убыток в виде штрафных санкций на 280 тысяч долларов. Однако, по словам адвоката, сам Кириченко не являлся подписантом договора, который стал причиной столь огромного штрафа.
Подписывайтесь на нас в соц. сетях