[Russian] Как писать технические тексты

Disclaimer: всё это только о технических текстах. Художественная литература, поэзия -- это совершенно другое, и с технической/научной литературой имеет мало чего общего.

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

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

Страх чистого листа (writer's block)

Я знал нескольких (пишущих, и даже известных) людей с этой проблемой.

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

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

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

Вам очень хорошо и умиротворённо! А после мутного самогона, как говорили во времена моей молодости, "как Иисус по душе босиком пробежал". Вам хочется жить в этом селе! Сало вкусное! И у вас в руках откуда-то появляется баян! (Или аккордеон.) И хочется спеть песню! Что-то из творчества Федора Чистякова (Ноль), например Иду, курю, Школа жизни, Человек и Кошка, Будет всё хорошо.

Также подходит творчество Братов Гадюкиных: Наркомани на городі, Карпати, Місячне сяйво твого тіла.

Совсем никакого страха перед (незнакомой) аудиторией в данной ситуации не будет, конечно.

Примерно с таким нагловатым ("наглость - второе счастье (а то и первое)") настроением деревенского гопника нужно садиться писать.

(Также, у Варлама Шаламова: "Но нахальство — второе счастье, по блатной поговорке, а блатную феню Парамонов знал.")

Еще в тему афоризм со времен фидо: "Не имей сто рублей, а имей наглую рожу".

Или просто представьте, что вы на пиве, пытаетесь своим знакомым рассказать что-то интересное. Говорите/пишете то, что первое в голову приходит (даже не важно что, любую чушь), потом всё равно придется много раз переделывать.

Но писать нужно спокойно

Штука в том, что писать нужно втрезвую, спокойно, в одиночестве, сидя в шумном Киеве. Без самогона, сала, баяна, бодрой музычки, и т.д. На улице жара, у соседей вечный ремонт. (Иногда бомбежки...)

Можно спорить, как правильно, как не правильно, наверное, это дело вкуса. Мне ближе всего по душе монотонный, преподский, полу-официозный, очень спокойный стиль, немного по-военному. Без мемов, шуточек, анекдотов. Даже, в некотором смысле, по-стариковски. В 2013-2014, когда я много писал RE4B, я, на ходу, много слушал фоном в плеере Ноама Хомского (это тот, который "иерархия Хомского"), даже не сколько интересуясь той политикой и лингвистикой, сколько мне нравилось слушать, как он разговаривает. Например: 1, 2.

В то время, когда писал по-английски, иногда в уме проговаривал все эти фразы голосом Хомского. Не знаю почему, но мне это помогало попасть в ритм, в колею. (Кстати, многие писатели вам подтвердят, что ровный/стабильный ритм это очень важно.) Если бы я хотел записать аудиокнигу, то я бы хотел её прочитать голосом Хомского (ну или в этой же манере).

В 2020-2021 я слушал британский подкаст In Our Time, теперь пытаюсь подражать манере Мелвина Брегга, например: 1, 2.

Но в любом случае, говорить/писать нужно как можно тише. Как писал Умберто Эко где-то: "Если вы тихо скажете что-то эпохальное, эффект будет громовой."

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

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

Еще в тему: "Сперанский не перебегал глазами с одного лица на другое, как это невольно делается при входе в большое общество, и не торопился говорить. Он говорил тихо, с уверенностью, что будут слушать его, и смотрел только на то лицо, с которым говорил." (Л.Толстой -- Война и мир.)

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

Мемы, коты, шуточки, смех#ёчки

Вы себе даже представить не можете, до какой степени это плохо.

Однажды я купил в супермаркете замороженную "котлету по-Киевски". Наивно полагая, что у меня сейчас активизируется кулинарный талант. Я её разогревал на сковородке. Снаружи она в итоге оказалась слишком горячей, внутри -- слишком холодной. Ни то ни другое есть не получилось. К тому же резкий перепад температур.

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

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

Даже очень хорошие анекдоты надоедают через несколько раз.

Чтобы убедиться в этом, попробуйте отмотать сайт anekdot.ru лет на 10 назад. Попробуйте почитать что угодно 10-летней давности -- новости, и т.д. Однажды у меня на компе случайно остался запакованный архив фидо, которому было лет 10. Почитать что там было -- это был очень необычный опыт -- и шутки, и анекдоты тогдашние, и новости... Это как картошка из Макдональдса -- пока горячая, еще терпимо. А когда холодная -- как бумага на вкус.

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

"Никогда не показывай публике, что ты ее боишься, но всегда показывай, что ты ее уважаешь." ( Л.Утесов )

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

Почему в Википедии нет шуток и мемов и котов, но её читают все? Почему в учебной литературе их тоже нет?

Лишние эмоции

Это вообще плохо. По крайней мере для технических текстов. Это мешает.

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

В общем, как можно меньше восклицательных знаков.

Эпиграфы не в тему

Это тоже очень плохо. Кстати, этим даже Дональд Кнут грешит.

Читатель видит эпиграф, запоминает, потом пытается его связать с чем-то далее по тексту.

Это как "Чеховское ружье на стене". Или оно должно когда-то выстрелить, или его не нужно показывать зрителям вообще. А иначе вы только захламляете всё.

Писать нелинейно

По неизвестным мне причинам, есть ряд известных технических писателей, которые пишут линейно. Я называю это "синдромом MS Word-а". Как будто бы при работе над книгой он видел перед собой только Word с одним файлом и больше ничего.

Кино снимают как попало, не обязательно с начала. Музыку записывают тоже как попало, кому как удобно. Ну а кто же вас заставляет писать книги от начала до конца, не отрываясь? Никто.

Где-то читал на каком-то форуме жалобы, как кто-то не может никак написать предисловие к своей писанине. (У меня слёзы умиления! Да господи же боже мой, кто же тебя заставляет прямо сейчас писать предисловие, потом его напишешь.)

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

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

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

(Кстати, я не раз слышал от музыкантов о том, что играть медленно труднее, чем играть быстро -- тут это тоже справедливо.)

Так не нужно! А нужно в начале распределить материал по частям, главам, итд. С каждой частью заниматься уже по отдельности. Если пришло в голову что-то -- в начале задумайтесь -- "в какой части текста/книги это будет лучше смотреться?"

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

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

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

Умничать это очень плохо

Люди это чувствуют, и им это не нравится.

Худший вариант в духе "а я такой умный, я знаю, как оно работает, но вам не скажу, а вы сами догадайтесь".

А что людям нравится? Описать коротко, по делу, без лишних эмоций, как оно работает.

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

А надо так: "вы тоже можете это сделать, на самом дешевом компе, без специальных знаний/образования". В стиле do-it-yourself.

Писать как можно меньше

Увы, сейчас у людей такая нетерпеливость, что все стараются снимать видео по-короче, писать тексты короткие, итд.

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

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

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

Но и тут нужно чувство меры. Немного избыточности иногда и не помешает. Коротко умели писать А.П.Чехов, Х.Л.Борхес, И.Бабель. Но некоторые доходили до крайности -- тот же Раймонд Карвер, читать которого уже могут далеко не все.


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

Но эти проблемы касаются худ.лита. После публикации вы как бы обязываетесь ничего не менять. Ваш роман/повесть/рассказ застывает навечно. Или стихи. Или песня.

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

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

Такое же отношение к ошибкам. Да, ошибаются все, ничего не поделаешь. Относитесь к этому как к разработке софта. Фиксите баги, как можете. Ну вот и всё.

Подготовка к письму

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

Был случай, когда я думал над одной вещью где-то 2.5 года, а написал потом за несколько дней. А, например, для этого поста, я собирал мелкие наброски еще с 2018-го года, но только сейчас дошли руки собрать всё в кучу и написать нормально. (Основная часть этого текста была написана в марте-2022, потом опять лежала мертвым грузом, а сейчас, в июле 2022 я надеюсь это наконец запостить в блог.)

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

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

Приходит в голову мысль или готовая фраза -- нужно записать. Я ходил с диктофоном в кармане. Андроидный диктофон бесил -- его долго включать и иногда там что-то глючило и он записывал тишину -- дико бесило. Так что у меня был журналистский диктофон с двумя кнопками. С ним и спал. Может я бы и не написал об этом, но я слышал лично, как один довольно известный человек признавался в том же, что ложился спать с диктофоном. Ну, раз я не один такой...

Нужно записывать за собой сразу же, как есть, чтобы не прервать "flow". У меня даже изредка выскакивают готовые фразы на украинском языке, так и записываю. (Потом переписываю, конечно же.)

Писать сразу на двух языках

RE4B я писал одновременно на двух языках (английский и русский, конечно), и это имело необычный эффект. Когда вы видите свой текст на двух языках сразу, желательно, на одном дисплее, сразу вылазит всякая неприятная мелочевка. Лишние слова-паразиты.

Я понял, что я не просто очень плохо знаю английский язык. Так я еще и русский плохо знаю. Да и у меня хватало украинизмов в русской речи (и это притом, что я с Донбасса).

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

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

Это сравнимо с писанием кода/алгоритма сразу на двух ЯП. Сразу вы увидите то, что важно по-настоящему.

Инструменты: компы и инет

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

Немалые части RE4B были написаны на обшарпанном маломощном нетбуке на Intel Atom. Когда у меня в "SAT/SMT by Example" попадаются упоминания о том, сколько какой-либо скрипт работал на Intel Atom -- это значит, что ту часть я готовил на этом нетбуке. Конечно, у меня был и более мощный комп, но он у меня часто используется как VM-ферма -- там куча разных OS, версий всякого разного, итд. Много юзал dwm на Линухе. Это самый примитивный оконный менеджер под Линух, что бывает, проще я не видел (хотя есть куда). Firefox на этом нетбуке работал, какую-нибудь Википедию можно было листать, а вот youtube и соц.сети -- уже нет, тормозил дико.

Пару лет назад я пошел еще дальше и у меня теперь есть дешевый и старый ноут без X Windows, работаю в голой консоли, чтобы еще меньше всего отвлекало. В стиле DOS-а первой половины 90-х, примерно. Там даже нет кириллицы. Например, я написал на нем это, сначала на Лиспе (Racket), потом переписал на Питон.

Потому что у меня пунктик! Я могу прямо сейчас встать из-за стола, выйти на улицу, уехать в другой город на неделю и потом вернуться. И чтобы за это время на дисплее моего компа не изменилось абсолютно ничего. То есть, вообще ничего, это не гипербола. Ни одного пикселя. (Поэтому нет часов.) Оконный менеджер dwm и голая консоль и эти критерии выдерживает. А андроид -- нет, так что мобилу я держу большей частью времени выключенной.

И конечно же немигающий курсор. Кто вообще придумал мигающий курсор? Наверное это рудимент со времен монохромных дисплеев. (Если бы он не мигал, его трудно было бы найти.) Но сейчас, с божьей помощью, дисплеи у нас цветные, так что курсор можно сделать в виде большого блока яркого цвета. У меня -- ярко-зеленый. Так его сразу видно.

У Д.Кнута два компа, на втором нет инета: I currently use Ubuntu Linux, on a standalone laptop—it has no Internet connection. I occasionally carry flash memory drives between this machine and the Macs that I use for network surfing and graphics; but I trust my family jewels only to Linux.

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

Часть 2013 и 2014, когда я много писал RE4B, я тоже отрубал инет. Был у меня DOCSIS-модем, но на другом конце комнаты. Чтобы что-то выкачать из инета, мне нужно было встать, дойти до другого конца комнаты, воткнуть модем, подождать пару минут, пока он забутится, потом уже гуглить.

Конечно, я накапливал много книг и документации на компах. Хорошо мне помогали локальные поисковики по PDF-кам -- DocFetcher под Винду и Recoll под Линух.

Более мягкий вариант -- выдернуть wifi-карточку из ноута и чтобы патчкорд валялся где-то подальше от вас. Может быть это дурость, а что делать? Как это говорилось в военных законах Мерфи -- "если это глупо, но это работает, значит это не глупо".

Пришло мне это в голову, когда лет 12 назад я одно время жил у "одних людей". Инета там не было, вернее, был, но просто патчкорд из стены, а роутера не было. И моблового инета у меня тоже не было. И был только дешевый ноут с собой. И как-то так получилось, что я за то время столько всего полезного спокойно делал, что решил повторить этот опыт. (А потом там купили роутер, я приконнектился через wifi и всё стало как обычно плохо.)

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

Как люди покупают дорогие ноуты, я вообще не понимаю. Прямо сейчас я пишу это на ноуте, купленном за $100. Ему 13-14 лет. И у меня их несколько, одинаковых. Потому что я где-то смотрел документальное кино про Metallica. У них две полностью одинаковых студии. Чтобы если у кого-то струна порвалась, они всё бросают, переходят во вторую студию и продолжают музицировать. Пока их гитарный техник меняет им там струны. И вот я наступил на провод, ноут грохнулся со стола на пол, появилось большое черное пятно на дисплее. Раньше была бы паника, будь у меня дорогой девайс. А сейчас я купил ровно такой же ноут "по объявлению", переставил винт и продолжил работать. Ну и всё!

К тому же, мне приходилось возить их с собой часто. Даже самые хорошие и дорогие ноуты от этого начинают приходить в негодность. Даже у thinkpad-ов хвалёных выпадают кнопки, винты бьются, в шлейфы забивается песок (а не надо было таскать их по пляжам). Так что, когда ноут дешевый, то хотя бы не жалко.

А так как ноуты дешевые и маломощные, нередко приходилось работать удаленно, на другом хосту, а это VIM под tmux. Из-за этого отвык от мыши, больше юзал браузеры вроде lynx/links/w3m -- тоже помогает поменьше отвлекаться.

К тому же, у меня (тьфу-тьфу-тьфу!) никогда не было проблем с туннельным синдромом. Я конечно не медик, но возможно это как раз оттого, что я юзаю мышь меньше, чем большинство людей.

А чтобы вы не подумали, что я нищеброд, я еще арендую довольно мощный сервак, но юзаю его просто как комп. В основном, как VM-ферму и файлопомойку. (Удобно еще и тем, что я не могу там наступить на провод и перевернуть его.)

Текстовый редактор

Часть RE4B была написана в Emacs-е, но большая часть всё-таки в Vim-е, причем, прямо в консоли, часто, с выключенной подсветкой синтаксиса.

Как юзать говнище вроде MSVS или Eclipse IDE я вообще не понимаю (но я честно пытался, в своё время). Те кто постарше, помнит, как на дискотеках под потолок подвешивали крутящиеся шары зеркальные. На них направляли светомузыку, стробоскопы и вся эта фигня всех пришедших граждан слепила. Но там была практическая польза от этого: "темнота -- друг молодежи". (Вы никогда не найдете хорошо освещенного ночного клуба, это будет мешать молодежному флирту.) Но зачем вся эта пёстрая цыганщина в серьезном инструменте, который вы каждый день юзаете по 10 часов -- это за гранью моего понимания. Всё это справедливо и для всех остальных текстовых редакторов, где выскакивают какие-то подсказки, автодополнения, и т.д.

Вернее, всё я понимаю. Всё это аналог цветных бус для туземцев. Так Microsoft и прочие вербуют молодежь в свои ряды. Для молодежи это важно -- всё цветастое, яркое, шумное, как сетевые фастфудные. (Так и для женщин: яркие украшения, цветные бусы те же...)

В моде редакторы вроде Visual Studio Code, Sublime Text -- но достаточно увидеть скриншоты, чтобы понять, что это не лучше, а то и хуже. Автодополнения продолжают выскакивать как кукушка из олдскульных настенных часов, как раз именно тогда, когда ты этого не ждешь.

Если вам не нравится Vim -- это дело вкуса, но я бы сказал, что тут есть один общий для всех совет. Ваша среда для работы должна быть такая, чтобы вы нашли нужное место в своей книге секунд за 5-10. Если слишком долго, это будет бесить. Я делаю это просто grep-ом, но у меня еще и очень много мелких TeX-файлов, мне так проще. (Я видел книги, где на каждую главу TeX-файл размером 100-200 килобайт -- не врубаюсь я в такое!)

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

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

История помягче -- некоторые мои знакомые из 90-х работали в редакциях газет. Подсели там на QuarkXPress. После этого они меняли работы, но продолжали верстать в "Кварке" даже коммерческие документы, счета, договора, мелкие объявления на стену, и т.д. MS Word не уважали и они.

(Если развивать эту тему дальше -- продукция MS была изначально расчитана на малый и средний бизнес. А это мелкие документы, договора, счета. И всё это для секретарш, бухгалтерш. И тут MS Word и MS Excel справляется лучше всех. Но когда речь идет о более длинных текстах со сложной версткой -- тут надо юзать что-то другое.)

Еще нужно вспомнить org-mode. Для него только Emacs и держу. Это действительно удобная вещь для структурирования текстов. (Именно этот текст тоже сочинялся при помощи org-mode.)

Простота это важно

Простота -- это особая роскошь, далеко не для всех доступная.

Потому что её трудно продать, в т.ч., начальству. Вы можете ночами сокращать ваш код/текст, а начальник потом спросит -- "и это всё, что ты сделал?!" И клиенты вашей компании могут задать тот же вопрос вашим маркетологам, продажникам, и т.д.

Вещи вроде тех, что тут -- не в фаворе.

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

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

Поэтому многие люди, включая писателей, всё очень усложняют.

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

Так и IT-молодежь, которой, бывает, важно показать, что они не такие как все, что они намного умнее, и они начинают изучать экзотические языки программирования, и т.д. Они точно так же не могут себе позволить делать что-то простое и всем понятное.

В то же время, на каком-нибудь MIT OCW, вы видите, как сильные ученые с мировым именем, терпеливо объясняют студентам простенькие основы -- они это могут.

И конечно же, "льют воду" чтобы замаскировать недостаток полезного контента. Так делают все кому ни лень, когда пишут курсовые работы, дипломы, и т.д.

Поэтому простых и понятных книг вообще мало. Мало кто может себе позволить быть простым и понятным.

Так или иначе, чтобы ваши тексты понимали и читали, нужно стремиться к простоте. Возможно, над вами будут стебаться. Так и стебались над RE4B из-за слова "beginners" в названии, но это слово я таки не убрал (да и домен beginners.re уже был всем известен).

Очень хороший пример -- вся документация к Unix и всё, что написал Б.Керниган. Вообще, если назвать только одного писателя, на кого равняться -- то это он. Если только одну книгу, то это его K&R. Думаете, эта книга выглядит просто? Ну так и Unix тоже выглядит просто, и, наверняка, благодаря этому, все эти инструменты и остались крайне живучими -- все они старше меня. Переплюнуть их очень трудно.

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

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

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

Еще пример -- алгоритм Диффи-Хеллмана, придуманный в 1976. Используется до сих пор в SSH, SSL/TLS. Крайне простой, есть описание в wikipedia. Но за кадром осталось то, что Диффи и Хеллман были к тому моменту очень серьезными экспертами в криптографии и у них уже были неудачные идеи до этого.

Быть скучным это не страшно

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

Я думаю, не нужно пытаться развеселить свою аудиторию. К тому же, вы никогда не знаете, кто эти люди.

"Рассказывают, что первая фраза, написанная Воннегутом на доске в творческой мастерской университета в Айове, была такая: «ПОМНИТЕ, ЧТО ВЫ ПИШЕТЕ ДЛЯ НЕЗНАКОМЦЕВ»."

Большинство людей читающих технические книги, это не молодые друзья-хипстеры, пока еще беззаботные, фланирующие по гастро-барам в историческом центре города. Большинство читателей -- это олдовые мужики с семьями, с долгами, с ипотекой, со сварливыми женами, с детьми-двоечниками. С севшим здоровьем, особенно, нервным. Возможно, эти люди приходят на работу с похмелья. У них просроченные дедлайны, нервное начальство и нервные же клиенты. Они идут гуглить свою проблему и попадают на Stack Overflow. Им нужно решение своей текущей проблемы и всё, больше ничего. Им не нужны мемы, бородатые анекдоты и фотки котов. (Поэтому на Stack Overflow их и нету.)

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

"Правило наименьшего удивления" и "нежданчики"

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

По этой же причине очень полезна предсказуемая и хорошо проработанная структура.

Забегая вперед...

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

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

Да, бывает постмодернистская литература, где рваные куски непойми чего хаотично свалены в кучу. Бывает гипертекстовая (вспоминаем М.Павича). Но это худлит! Который, к тому же, далеко не всем по нраву.

Кстати, в Википедии эти идиомы не используются. И как вы думаете, почему?

Самый короткий совет

Если всё сжать до одного совета -- нужно много раз перечитывать свою писанину.

"Повтори свои стихи вслух тысячу раз" (Мацуо Басё).

(Так и музыканты много раз репетируют одно и то же: начиная от диджеев и инди-рокеров, заканчивая высоколобыми джазменами и авангардистами.)

Всё! Больше ничего не надо делать! И вы сами дальше всё поймете. Что нужно всё много раз редактировать, переделывать. Что мемы и шуточки и всякий подобный эмоциональный хлам -- очень мешают, раздражают. Что инструменты нужны как можно проще и надежнее и без лишнего "visual candy". Что нужно как можно меньше отвлекаться на всё.

Я так делал, но не потому что я весь такой из себя трудолюбивый -- всё было проще. Где-то в 2015, китайский переводчик находил у меня много косяков и заваливал меня емылами. Не только об ошибках писал, но и о том, что он чего-то не понимает. (Если переводчик чего-то не понимает, это плохой симптом, надо переделывать.) Так я много раз всё перечитывал и переделывал.

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

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

Пример менее известный -- Л.Толстой переписывал "Войну и мир" не помню сколько раз, но тоже читается как горячий нож по маслу.

Еще один вариант это просто рассказывать истории вслух, кому-то на пиве. Если это делать много раз, то лишнее отваливается, остаётся самое важное. Это справедливо и для тех, кто пишет худлит.

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

И очень полезно описывать всё подряд. "Акын, что вижу -- то пою". Так учат художников -- зарисовывать всё подряд, что видят.

А в случае с технической литературой -- кодить всё подряд, всё, что только можете, писать конспекты при учебе (оказывается, это полезно -- в ВУЗах нам не врали).

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

Писать в спешке

Наверное тоже полезно, отсекается неважное.

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

Таковы, например: С.Н.Виноградов и А.Ф.Кузьмин -- Логика, учебник для средней школы.

И конечно же: Бертран Рассел -- История западной философии. Расселу было уже 73 года. Видать, он уже понял к тому моменту, как надо писать научпоп. Книга оказалось очень удачной и стала известной.

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

Затруднять процесс писания текстов вообще может быть полезным. Хорошо у Паустовского было: "Щелкунов был похож на земского доктора. Всегда мокрая его бородка была всклокочена, а пиджак висел мешком под тяжестью карманов, набитых книгами и рукописями. Тогда еще не было автоматических ручек, и Щелкунов носил в кармане чернильницу «Ванька-встанька» и несколько гусиных перьев. Карандашом он писать не мог, и, кажется, один только я понимал его и не посмеивался над этим его свойством и над гусиными перьями. Все написанное карандашом всегда казалось мне небрежным и недоделанным. Я считал, что четкая мысль требует четкого написания. Если бы можно, то я писал бы только китайской тушью на плотной бумаге."

И чувство меры

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

Writer's block / творческий кризис

Часто вы это видите в кино и сериалах вроде Californication ("Блудливая Калифорния") -- писатель в кризисе, не может писать, депрессивно слоняется без дела, побухивает.

Возможно, никакого творческого кризиса и не существует. Но реально существуют известные проблемы со здоровьем. Гуглим симптомы неврастении, астении и burnout-а (выгорание) -- ба, знакомые всё лица!

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

А как надо было? Распорядок дня, работать не больше N часов в сутки, никаких ночных бдений и дедлайнов. Если есть заказчики, требующий от вас работу в срок -- послать их далеко, ибо здоровье всегда дороже денег. Только ЗОЖ, физ-ра, контакты с людьми живьем. Если позволяет здоровье и есть чувство меры -- пьянки, тусовки и легкомысленные девицы.

Спокойная работа 2 часа в сутки с ясной головой и хорошим КПД может быть значительно более продуктивнее, чем суетливая работа в дикой спешке 15 часов в сутки после недосыпа -- "я гарантирую вам это" (как говорят на Луркморе). Рано или поздно к этому приходят. К тому же, бОльшую часть работы вполне можно делать в уме, даже фоном.

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

FAQ (ЧаВо)

А еще надо вспомнить FAQ-и (ЧаВО). Они были популярны в Фидо и usenet-е. Читать их было приятно. Да и до сих пор. Но не потому что их сочиняли гениальные писатели и редакторы (их было крайне мало среди тех технарей), а потому что формат обязывал. Четкий вопрос и четкий ответ. Тут нет места для бессмысленных эпиграфов, фоток котов, шуточек, и т.д. К тому же, FAQ-и заключали в себе только то, что действительно интересует людей -- часто задаваемые вопросы. А это и варианты решения частых проблем. По содержанию ("контенту"), качество FAQ-ов было довольно высоким, на уровне хороших книг. И это не смотря на то, что авторы обычно не владели пером, а были просто технарями, опытными в своих областях.

Кстати, FAQ-и часто перечитывались. В Фидо, FAQ могли постить в фидоэху автоматически раз в неделю. И нередко его перечитывали многие подписчики.

Потом в Linux-ах были HOWTO, это уже похуже. Потому что формат более вольный, и автор, часто, один. Но всё равно хорошо, потому что HOWTO преследовали четкую цель -- ответить на вопрос, как настроить звуковуху под Linux или еще что.

Иметь ясно поставленную цель это очень и очень важно. И в жизни и в технической писанине.

А Фидо было примитивным и неудобным, но было в нем и хорошее. Ваш покорный слуга начинал его юзать в 1994-1995, юзая модем на 2400 бод (бит в секунду). А это ~240 байт в секунду. Байт, Карл! В секунду! Для передачи среднего анекдота в виде текста нужно 1-5 секунд. И это через глючные советские олдскульные декадно-шаговые АТС. Через мерзкий межгород. (Межгород, к тому же и дорогой.) И постоянно рвалась связь.

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

Эти же ограничения были и в usenet-е, который гнали через UUCP, через те же невыносимо тормозные модемы. То есть, интернет (точнее, его предтеча) особо лучше не был по качеству информации (с usenet-а просто копипастили в фидо или гейтовали). И те же модемы и телефонные линии. Только надо было еще и платить за это.


(Пост писался/обновлялся с июля-2022 по июн-2023.)

(the post first published at 20220705.)


List of my other blog posts.

Subscribe to my news feed

Yes, I know about these lousy Disqus ads. Please use adblocker. I would consider to subscribe to 'pro' version of Disqus if the signal/noise ratio in comments would be good enough.