Как я пишу статьи
После вопроса к статье Как я писала курс Python для сетевых инженеров, решила написать чуть подробнее о том, как я пишу статьи.
Зачем
Для начала, зачем я в принципе пишу их. Причин много. Иногда присутствуют только некоторые из них, иногда - все вместе.
Я пишу, чтобы лучше запомнить и упорядочить информацию.
Как правило, я пишу статью/заметку, когда разобралась с темой (или так думаю). По дороге быстро становится понятно, что я действительно поняла, а что нет.
Если я могу описать/объяснить что-то своими словами - значит я поняла тему. При этом, когда получается объяснить четко и структурировано - значит я поняла тему хорошо. Конечно же, всё это с оговоркой, что я давно пишу статьи и для меня это и правда способ проверки себя.
Я пишу, чтобы поделиться интересными вещами, которые попались мне.
Если попадалось что-то интересное, особенно то, с чем пришлось долго разбираться, чтобы понять, это нужно записать. Так и я сама не забуду и кому-то может пригодиться.
Сначала я думала, что полезными могут быть только большие завершенные статьи, но, со временем, я начала выкладывать на xgu.ru и просто заметки, в которых было совсем немного текста и примеры конфигураций. И даже они оказывались полезными.
Я пишу, чтобы поделиться тем, чем я горю
Когда я горю какой-то темой, мне хочется об этом рассказать. К сожалению, часто так получается, что вживую вокруг меня мало людей, которые горят этими же темами. Например, для многих сети это просто работа и говорить и думать об этом в свободное время никому не хочется. И, соответственно, не хочется и учить и узнавать новое просто так, но можно об этом написать и найдутся люди, которым это будет интересно и полезно.
Я пишу потому что считаю, что знаниями и информацией надо делиться
Тут могут быть разные взгляды. Кто-то считает, что “ага, я учился, а теперь тебе всё на тарелочке выложу”. Я за то, чтобы делиться информацией. И за то, чтобы делиться ей бесплатно.
Да, всем нам надо зарабатывать и так далее, но и я сама, например, книжку по питон выложила бесплатно, но курс читаю платно.
Главное, что когда вы делитесь информацией, когда рассказываете кому-то или пишите статью, вы очень-очень много даете, в первую очередь себе. Это улучшает и структурирует знания, выявляет пробелы.
С чего всё началось
Началось всё со статьи Опция 82 DHCP на xgu.ru 3 апреля 2008 года. Это был тот случай, когда я разобралась с интересной штукой и захотелось её где-то описать, чтобы и другие могли почитать.
У моего коллеги Игоря Чубина был сайт xgu.ru и он посоветовал написать там статью. Честно говоря, первые несколько статей было страшновато писать и было много сомнений:
- Это же будут читать другие люди
- Надо всё сто раз вычитать
- А вдруг что-то напишу неправильно
- Я же ничего такого не знаю, чтобы писать статьи
К этому добавлялось то, что xgu.ru уже был крутым ресурсом и было ещё страшнее, но со временем стало не так страшно. Особенно, когда я увидела, что даже небольшие заметки могут быть полезны людям.
Процесс создания статьи
С чего начинается статья
Чаще всего, статья начинается с того, что я разобралась с какой-то интересной штукой и хочется это записать, чтобы не забыть.
Тут главное не потерять эту волну интереса и записать сразу как можно больше. Со временем часто интерес угасает и/или появляются новые интересные штуки. Иногда я писала статьи, например, из-за того, что какая-то мелкая заметка становилась популярной на xgu.ru и было стыдно, что там только пару выкладок конфигурации.
У нас на xgu.ru даже была своя внутренняя страничка “Стыдные страницы”. Там были страницы на которые много заходов из google, но при этом там очень мало текста.
Иногда я просто вижу, что по какой-то теме нет нормальных статей на русском и хочется восполнить пробел.
Структура
Следующий шаг - создание структуры статьи. Для меня этот этап всегда проходит на бумаге - так я лучше думаю.
Структура составляется в несколько этапов. Практически всегда, в процессе написания статьи структура начинает меняться, а для больших статей - это происходит всегда.
На этом этапе я придумываю последовательность повествования, рисую связи между различными частями. Отмечаю, что надо упомянуть обязательно, а что можно оставить в виде ссылок на другие ресурсы.
Текст статьи
После создания структуры, начинается непосредственная работа над статьей.
Практически всегда я пишу не последовательно по структуре. Очень часто, когда я пишу одну часть, мне приходят идеи по другой части. Я обязательно их записываю коротко или на бумаге или в самой статье, в соответствующем разделе.
Очень часто бывает, что мне сложно подобрать вступительный слова. Сложно сформулировать основную идею. В таком случае, я откладываю это на потом. Обычно всё приходит само по себе, в ходе написания статьи или в конце её написания.
Как правило, процесс написания статьи сменяется редактированием и переписыванием. При этом это происходит не один раз, а циклически снова и снова.
При редактировании, часто получается так, что надо поменять пару абзацев и, после нескольких смен формулировок, оказывается, что общая картина стала хуже.
В таком случае, обычно лучше начать с нуля и переписать эти абзацы заново. Чаще всего в итоге рождается намного более четкое и структурированное описание, чем результат от правок.
После завершения статьи обязательно надо прочитать её полностью. Как правило, не один раз. Учитывая то, что я могу писать статью несколько дней, в итоге какие-то части могут быть оторванными друг от друга или пересекаться во многом.
Эти финальные прочитывания позволяют проверить получилось ли объяснить то, что я хотела.
Мои правила написания технических статей
Эти правила - это то, к чему я стремлюсь. У меня не всегда и не всё получается с первого раза. А иногда и в принципе не получается.
Многие очень субъективны. Например, мне может казаться, что написано просто и понятно, а для кого-то это не так.
Статья должна быть написана простым и понятным языком.
- Надо стараться не использовать лишний раз специфические термины
- если какие-то термины используются, то нужно объяснить их
- Стараться строить простые предложения, без всяких замысловатых оборотов
- Использовать аналогии, примеры
Написать статью понятным и простым языком может быть очень сложно. Ведь, например, в обычной речи, когда вы что-то рассказываете, слушатель может задать вопрос, переспросить непонятные моменты или попросить повторить что-то.
При написании статьи нет возможности получить отклик от читателя, пока вы не завершите статью. И даже когда статья завершена, если она написана непонятно, скорее всего, отклика просто не будет, так как читатель ушел читать что-то другое.
Поэтому на формулирование мысли в письменном виде часто уходит очень много времени. Особенно, когда вы только начинаете писать статьи.
Информация должна быть хорошо структурирована.
- Если можно преобразовать какие-то пункты в список - лучше так и сделать. Так информация лучше воспринимается.
- Лучше не писать очень длинные абзацы.
- Основные моменты выделять с помощью оформления или структуры предложения/абзаца.
- Если получается, объединить информацию в таблицу.
- Лучше добавлять к пояснениям схемы, иллюстрации.
Также важно, чтобы были явно выделены части статьи и они были понятным образом структурированы и связаны друг с другом.
Если в статье большое количество разделов, лучше сделать содержание статьи в самом начале.
Цель - объяснить что-то читателю
Этот аспект может быть совсем не актуален, если вы просто пишите заметки для себя, но для меня это очень важный аспект. Я всегда стараюсь написать так, чтобы это было понятно. Эта цель помогает улучшать текст, объяснения, статью в целом, даже когда я пишу для себя.
Я стараюсь перечитывать всё со стороны. Пытаюсь понять складывается ли всё в общую картину.
Когда цель - объяснить что-то, то я продолжаю менять статью, пока не увижу, что я написала так, что это понятно, структурировано и нормально воспринимается.
Это во многом пересекается с чтением курсов. На курсе иногда надо повторять объяснения. И некоторые думают, что меня это напрягает, но на самом деле нет.
Так как моя задача - объяснить, пока я не вижу, что человек понял, я буду искать другие примеры и способы объяснения. Ведь цель ещё не достигнута. А значит не важно сколько раз я повторяю что-то за курс или объясняю другими словами то же самое. Только когда человек понимает, работа закончена.
Изменения - всегда к лучшему
Очень часто статью приходится переписывать. Иногда небольшую часть в пару абзацев. А иногда несколько страниц.
Именно эти изменения помогают со временем улучшить и выработать свой стиль, улучшить статью и лучше её структурировать.
Нужно быть готовым к тому, что с первого раза не получится идеально. Что нужно будет перечитывать отдельные фрагменты и всю статью.
Пожалуй, как минимум, стоит перечитать статью два раза. При этом, в каждой итерации, возможно, нужно будет много раз перечитывать отдельные абзацы.
Начинающим
Это лично мои правила. У вас они могут быть другими
Вырабатывайте свои правила. Пишите так, как нравится вам. Например, все говорят надо писать в третьем лице, но возможно вам нравится писать по-другому и именно это станет вашей фишкой.
Найдите свой стиль
Пишите так, как у вас получается. Пишите так, как считаете правильным. Со временем, обязательно будет получаться лучше и вы сможете выработать свой стиль.
Например, когда я начинала писать статьи, я писала на xgu.ru, а там уже было множество статей Игоря Чубина. У него статьи получались не только технически грамотными и понятными, но и веселыми, с приколами и великолепными аналогиями. И когда я начала писать, я расстраивалась, что я не могу писать так, как он. Я понимала, что у меня другой стиль и что я не могу написать так же.
Со временем, я поняла, что это нормально. Я нашла и свой стиль и спокойствие. Я поняла, что я могу хорошо объяснить вещи. Не идеально и однозначно есть к чему стремиться, но это у меня получается.
Я по-прежнему часто сравниваю себя с другими, подвергаю сомнению то, что я делаю, как делаю, но это часть процесса усовершенствования. Это бесконечный цикл, который надо проходить снова и снова, чтобы становиться лучше.
Например, когда я писала книгу по питону, я думала, что если бы Игорь писал её, то она бы была фееричной, увлекательной и очень классной :).
И в то же время, я знаю, что, хотя для меня важны эти качества, мои главные приоритеты - простота и понятность. И конкретно с этой книгой я верю, что это получилось.
Конечно, иногда хочется писать феерично, но это скорее в рамках общего желания быть лучше, писать лучше. Это не значит, что мой стиль написания хуже.
И очень важно обрести уверенность в том, что у вас есть свой стиль и что он заслуживает права на существование.
Найдите свою мотивацию
Это очень важный момент. Надо найти не только свой стиль, но и свою мотивацию и цель. Если вы знаете для чего и почему пишите, вы сможете пройти через все эти сомнения и продолжить писать.
Когда вы начнете писать, вы можете столкнуться с тем, что окружающие будут говорить “зачем это нужно?”, “полно статей по этой теме”. Не поддавайтесь этим комментариям. Если чувствуете, что хочется написать статью - пишите.
Когда я начала писать книгу по питон, многие говорили, что это никому не нужно, что такого полно и так, но я хотела рассказать об этом так, как вижу я. Я верила, что это нужно и важно и мне очень хотелось довести это до конца.
К сожалению, в русскоязычном сообществе очень распространены непрошенные советы и критика. И я бы даже не назвала это критикой. Это просто такой тип возгласов “зачем всё это”. Очень часто так пишут те, кто сам ничего не делает. Эти люди будут приходить и писать такое, но главное на них не реагировать.
Со временем вы найдете и свою аудиторию, которая будет поддерживать и читать статьи. Которой интересно именно то, что пишете вы.
Конечно, надо быть готовым и к конструктивной критике, к тому, что будут ошибки и на них будут указывать, но это наоборот очень хорошо, так как позволяет улучшить статью, а может и увеличить знания.
Чем больше вы будете писать, тем лучше будет получаться
Несомненно бывают люди у которых есть талант или предрасположенность к каким-то вещам. И кому-то написание статей может даваться легко сразу. Но даже тем, у кого есть талант, придется много работать и будет что улучшать.
Когда вы начнете писать, скорее всего, всё будет получаеться очень медленно.
Когда я начинала, я могла час писать пару абзацев. Было сложно формулировать мысли четко. И хотя на курсах рассказывать получалось достаточно легко, статьи давались тяжелее. Это другой навык и его надо развить.
Поэтому просто продолжайте писать и очень скоро это будет получаться лучше и быстрее.
Мой checklist
Это пункты, которые я выписала для себя из разных источников, когда редактировала курс “Python для сетевых инженеров”. Конечно же, я выписывала именно то, что актуально для меня и по тем аспектам, которые мне надо было исправить. Поэтому очень рекомендую посмотреть ссылки в конце статьи. Там вы найдете намного больше советов и сможете выбрать важные для вас.
- Писать от третьего лица. Использовать “я” и “мы” только когда нужно
- очень часто получается так, что изложение информации от третьего лица будет проще и понятней. Пример моих правок в книге, где я исправляла стиль изложения
- Явно указывать раздел, вместо “рассмотрим позже” или “рассматривали раньше”
- Не повторять слова и одно и то же по смыслу
- Писать в активном стиле
- Меньше использовать прошедшее время
- Без эмоций (типа “круто!”)
- Иллюстрации! Больше иллюстраций!
- Меньше скобок, лучше вообще без них
- Числа от 1 до 10, и числа в начале предложения, писать буквами
Это пункты, которые мне надо было исправить и некоторые из них очень мелкие. О более глобальных вещах я уже написала в начале статьи.
Ссылки
Общая информация на русском:
Общая информация на английском:
- Technical writing style. Wikiversity - эта статья является частью курса Technical Writing. В ней коротко описаны различные аспекты написания технических статей. Для каждого аспекта есть примеры. И, хотя статья написана для английского языка, практически все аспекты актуальны и для статей на русском
- Guide to technical writing - рекомендации студентам по написанию технических статей
- Tips for Academic Writing and Other Formal Writing - еще одна отличная подборка советов студентам
Написание от третьего лица в научной литературе: