На­писа­ние тех­ничес­ких ста­тей — занятие, в котором я упражня­юсь дав­но и регуляр­но. Нас­толь­ко, что уже могу давать дру­гим советы. Недав­но меня поп­росили выс­тупить с ними на кон­ферен­ции OFFZONE 2022, что я и сде­лал. А по мотивам мас­тер‑клас­са наб­росал этот спи­сок тех­ник и лай­фха­ков, которые счи­таю самыми важ­ными.
 

1. Пиши о том, что тебе интересно

Пер­вая статья дает­ся тяжелее все­го. Одна из при­чин в том, что новые авто­ры час­то берут слиш­ком гло­баль­ную тему, которой хва­тило бы на трех­томник, или, наобо­рот, пыта­ются рас­писать совет, который умес­тится в три пред­ложения (и кусок кода в слу­чае с «Хакером»). Посове­товать готовое решение здесь неп­росто, но с прак­тикой ты научишь­ся попадать в нуж­ные фор­маты.

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

И ни в коем слу­чае не под­давай­ся син­дро­му самоз­ванца. Если ты толь­ко начал раз­бирать­ся в теме, о которой пишешь, это тоже может быть пре­иму­щес­твом: ты на все смот­ришь све­жим взгля­дом и еще пом­нишь, обо что спо­тыка­ются нович­ки. А работая над стать­ей, ты сис­темати­зиру­ешь и углу­бишь свои зна­ния.

 

2. Описывай действия, а не объекты

Ес­ли ты прос­то возь­мешь и опи­шешь какую‑то вещь (про­токол, фор­мат, устрой­ство), то получит­ся скуч­ная справ­ка, а не статья. Най­ди проб­лемати­ку, и все ста­нет куда веселее. Напиши о сво­ем опы­те или о том, как решать кон­крет­ную задачу.

От­личный инди­катор того, что статья вый­дет ста­тич­ной и зануд­ной, — заголо­вок, в котором нет гла­гола, то есть дей­ствия. Поэто­му какой‑то вре­мен­ный заголо­вок сто­ит написать с самого начала. Заод­но поможет луч­ше очер­тить тему.

 

3. Начинай с сути

Лю­бимый при­ем некото­рых авто­ров — начать с какого‑нибудь до боли оче­вид­ного утвер­жде­ния. Не сто­ит так делать. Начинай сра­зу с сути! И писать, и читать такой текст будет лег­че.

Ког­да допишешь статью, вер­нись в начало и добавь лид — абзац, который будет сооб­щать читате­лю, зачем тра­тить вре­мя на чте­ние все­го осталь­ного. Что человек узна­ет из тек­ста? Чему научит­ся? Где при­годят­ся эти зна­ния? Почему тема кру­та и акту­аль­на? Все это поможет ему не скрол­лить статью в попыт­ках узнать ответ самос­тоятель­но.

 

4. Не старайся звучать умнее

Же­лание зву­чать более уве­рен­но не тянет на смер­тный грех, но вынуж­дает авто­ра сти­лизо­вать текст под что‑то, чем он быть не дол­жен. Сре­ди любимых ори­енти­ров: науч­ная работа, полицей­ский про­токол и ста­рин­ное пись­мо.

Яв­ный мар­кер пер­вого — уто­митель­ная избы­точ­ность и сло­ва вро­де «явля­ется» и «дан­ный». Вто­рого — «в следс­твие». Любите­лей ста­рины выда­ют сло­веч­ки вро­де «ибо» и «покуда». А иног­да текст перек­люча­ется меж­ду эти­ми режима­ми про­изволь­но.

Тех­ничес­кие статьи луч­ше все­го писать прос­тым и понят­ным язы­ком — поч­ти раз­говор­ным, но более склад­ным. Любые укра­шения ско­рее помеша­ют вос­при­нимать и без того гру­зящее мозг содер­жимое (а по неопыт­ности, ско­рее все­го, еще и вый­дут кри­во). Так зачем усложнять себе жизнь?

 

5. Пойми, почему остановился

Что делать, если работа вста­ла и никак не идет даль­ше? Убрать­ся в ком­нате, пос­мотреть сери­аль­чик и выпить пив­ка — неп­равиль­ные отве­ты. Единс­твен­ный про­дук­тивный спо­соб прок­расти­нации — еще раз перечи­тать написан­ный текст.

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

Бы­вает и так, что прос­то не получа­ется сфор­мулиро­вать пред­ложение. Поп­робуй написать начер­но, пометив этот учас­ток любым удоб­ным обра­зом. Зачас­тую чер­новой вари­ант ока­зыва­ется очень бли­зок к чис­товому, или нуж­ная фор­мулиров­ка сама при­дет к тебе при оче­ред­ном перечи­тыва­нии.

Ну и в кон­це кон­цов, не забывай, что ты можешь дей­стви­тель­но устать. Написа­ние ста­тей — интенсив­ный мыс­литель­ный про­цесс, который за четыре‑пять часов силь­но исто­щает мозг. Зато пос­ле про­гул­ки или сна под­созна­ние может само родить решение проб­лемы. Глав­ное — не забудь вер­нуть­ся к работе!

 

6. Будь честным с читателем

Сре­ди более опыт­ных авто­ров попада­ются хит­рецы, которые вмес­то допол­нитель­ного ресер­ча научи­лись акку­рат­но обхо­дить мес­та, где им не хва­тило зна­ний. Редак­тор, конеч­но, сра­зу замеча­ет такие манев­ры. Воз­можно, и читатель тоже. Либо (что еще хуже) нач­нет мотать текст туда‑сюда и удив­лять­ся, почему о каком‑то важ­ном момен­те ничего не ска­зано.

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

Есть и более мел­кий, но не менее досад­ный вид неточ­ностей — те, которые пря­чут­ся за сло­вами типа «доволь­но», «некото­рый», «отно­ситель­но». При­веди вмес­то рас­плыв­чатой оцен­ки точ­ные дан­ные, и текст от это­го выиг­рает.

 

7. Выкидывай все лишнее

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

Нач­нем с абза­цев. «Воду» ты, ско­рее все­го, заметишь, а если нет, то редак­тор лег­ко сце­дит ее. Более слож­ный слу­чай — ког­да текст ходит по теме кру­гами. Тог­да нуж­но убрать пов­торы, а осталь­ное перес­тавить в логичес­ком поряд­ке.

Пов­торы встре­чают­ся и на уров­не пред­ложений. Если написал «дру­гими сло­вами» — воз­можно, есть смысл оста­вить толь­ко иду­щий даль­ше вто­рой, более ясный вари­ант объ­ясне­ния. Заод­но воз­держись от напоми­наний, что что‑то уже было выше или что читатель может уже знать изло­жен­ные фак­ты.

Что до лиш­них слов, то их в основном пло­дит кан­целяр­ский стиль. Если что‑то мож­но ска­зать одним сло­вом — ска­жи одним, а не дву­мя‑тре­мя! Очень час­тый при­мер: «для того, что­бы» всег­да мож­но заменить на «что­бы».

 

8. Записывай идеи

Что, если ты пишешь что‑то одно, а в голову при­ходит мысль, которая отно­сит­ся к сов­сем дру­гой час­ти статьи? Ни в коем слу­чае не теряй ее, она может не посетить тебя сно­ва!

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

Ос­тавляя работу до дру­гого раза (осо­бен­но если он будет не на сле­дующий день), всег­да выг­ружай из головы все цен­ные пла­ны и идеи. Может казать­ся, что память не под­ведет, но замет­ка всег­да надеж­нее.

 

9. Практикуйся больше!

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

Хо­рошая новость: тех­ничес­кому спе­циалис­ту вов­се не обя­затель­но быть клас­сным писате­лем, что­бы пуб­ликовать­ся! В «Хакере» боль­шую часть тек­стов пишут новые авто­ры, которые хотят прос­то поделить­ся сво­ими зна­ниями. Мы ста­раем­ся доводить тек­сты до ума силами редак­ции или хотя бы совету­ем, что и как улуч­шить.

info

Ес­ли при­думал тему для «Хакера» и готов садить­ся за работу, опи­ши идею парой пред­ложений и отправь мне на pismenny@glc.ru. Если тема нам под­ходит, я выш­лю усло­вия и допол­нитель­ные рекомен­дации.

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

Подписаться
Уведомить о
1 Комментарий
Старые
Новые Популярные
Межтекстовые Отзывы
Посмотреть все комментарии