Как мы пишем статьи на Хабр: опыт разработчиков EastBanc Technologies

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

    Для начала достаточно ответить на два простых вопроса:

    • Зачем это мне?
    • Что я расскажу интересного и полезного хабраобществу?

    После чего можно взять план из этой статьи (или придумать свой) и сделать это.

    image

    Есть творческие этапы и технические. В этой статье поговорим о творческих. Рассмотрим:

    • Зачем писать статьи,
    • Откуда взять тему для статьи,
    • Где найти время, чтобы её написать,
    • Основные этапы работы над текстом,
    • Что делать, если статья «не идёт»,
    • И с чего начать, если ты ни разу не писал на Хабр.

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

    Мотивация: зачем мне, разработчику, писать на Хабр


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

    • Социализация
      Мотивирует сопереживание и чувство общности — хочется поделиться эмоциями и мыслями о процессе разработки с заинтересованным сообществом.
    • Систематизация своих знаний
      Нравится порядок в своей голове, а написание статьи или вообще итогового текста позволяет многократно ускорить нахождение пробелов в понимании и знании о теме. Статья позволяет посмотреть на тему с разных сторон, до конца выяснить все непонятные моменты, реализовать что-то.
    • Интерес разобраться в новом и поделиться
      Мотивирует писать про что-то новое для себя, про то, что свежо в мире разработки. Если бы я занимался типичными задачами, то не думаю, что с этого был бы какой-то выхлоп. По большому счету, на выходе получается инструкция с прибаутками или без, которая напоминает развернутый ответ со Stack Overflow по вопросу/теме, заданной в заголовке статьи.
    • Экономия времени на обучение внутри
      Статья как конспект для своих коллег, которым всё равно предстоит это потом рассказывать. А так написал — и разослал или провёл семинар.
    • Получение обратной связи и комментариев общества
      Просмотры и плюсики в зачетку получать довольно приятно, улучшает карму. Улучшенная карма также мотивирует писать дальше. В комментариях можно почерпнуть для себя полезную информацию от ребят, которые пошли той же дорогой и уже набили шишек.
    • Ради всего хорошего
      Вдохновляет желание ускорить развитие человечества — если любая деятельность автора сэкономит людям больше времени, чем он потратил — в среднем человечество скорее всего выиграет в развитии, поскольку сэкономленное время будет вероятно потрачено на полезную деятельность.

    Выбор темы с учетом полезности для Хабра


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

    Хорошие темы


    • Бывают решения, про которые разработчики говорят: «В официальной документации про это не было, на Хабре тоже. Пришлось повозиться». Если само решение достойное, значит, и статья будет хорошей.
    • Некоторые темы вытекают из глобальной задачи, которая поставлена на проекте – например, обеспечить High Availability и прозрачный CI/CD. Каждый шаг на пути к этой цели – миграция на .Net Core, Docker и так далее – может быть описан в отдельной статье. На митингах частенько проскакивает шутка «в статью!», т.е. коллеги как бы намекают.
    • Часть тем приходит, когда ты активно исследуешь новую тему. Есть примета: если разработчик потратил на исследование больше 4 часов в Google или на чтение других статей – значит, стоит сделать хотя бы компиляцию найденной информации, а может, и написать что-то новое.
    • Некоторые тексты рождаются после прочтения интересной книги, посещения хорошей конференции или даже как внутренняя документация — хочется поделиться новыми знаниями.

    Хорошо то, что приносит пользу, экономит время в будущем у читателей и дает практический опыт, а не философские измышления о мире во всем мире.

    Плохие темы


    Таких есть великое множество, но упомянем некоторые из них:

    • Повтор всем известного с единственной целью проиндексироваться по ключевым словам,
    • Прямая или косвенная реклама компании или клиента (смотрите, с кем я работаю),
    • Статья ни о чем или бесструктурный поток мыслей.

    В общем плохо всё, что не несет пользы читателю или его не уважает.

    Основные этапы работы над текстом


    Для автора работа над текстами проходит через 6 созидательных этапов:

    1. Целеполагание: формулирование темы, идеи и плана. Чтобы нащупать тему, мы отвечаем на вопросы «Что нового читатели узнают из этой статьи», «Для кого мы её пишем», «Чем именно хотим поделиться». Ещё нам важно, чтобы статья привносила что-то новое. Для этого смотрим по ключевым словам, что уже написано на эту тему и не повторяемся ли мы.
    2. Заметки, или лабораторный журнал. В ходе работы над задачей разработчики делают заметки: сохраняют полезные ссылки, записывают якоря-напоминалки по нештатным ситуациям, чтобы затем можно было от-реверс-инжинирить заметки в читаемый текст. Когда доходит до текста, остаётся только перечитать «лабораторный журнал», переформулировать некоторые записи с использованием более-менее общепринятой лексики, а потом собрать в логичном порядке.
      Один из наших авторов использует онлайн markdown-редактор hackmd.io, где фиксирует свои шаги в разработке темы. Этот инструмент позволяет расшарить текст, показывать прогресс по статье, а главное — заранее сверстать её. В итоге получается текст, в который для публикации на Хабре достаточно добавить кат и придать пару мелких штрихов. Это удобно, чтобы контролировать структуру и верстку текста.
    3. Упорядочиваем текст. Выписываем главные мысли и смотрим на их полезность и место в структуре статьи. Получается оглавление, то есть кластеризация текста на смысловые блоки, которые можно воспринимать, даже не читая другие разделы.
    4. Редактируем и правим, чтобы посторонний человек «не в теме» мог более-менее понять смысл сказанного. Можно каждый день хотя бы раз перечитывать написанное и править то, что не нравится. Правка идёт в несколько итераций, как и работа над текстом. На этом этапе смотрим на язык и ошибки — непроверенный текст читается так, словно написан школьником-двоечником.
    5. Смотрим на текст чужими глазами: статью читает другой разработчик или PM, компетентный в этой теме. Свежий взгляд и конструктивная критика улучшают продукт.
    6. Готовим текст к печати. Вносим финальные правки, продумываем иллюстрации, выбираем подходящие хабы — и в печать!

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

    А теперь от планов — к действию. То есть к тексту.

    Очень много задач: как найти время для работы над текстом


    Работа над текстами в стиле «отдодвинул все задачи и ушёл с головою» у нас не складывается из-за bus factor. Поэтому авторы понемногу занимаются статьей в фоне остальной работы. Зачастую текст является конспектом актуальной рабочей задачи.

    Один из наших авторов сравнил эту работу с тестами. Сначала думаешь, что нет времени писать тесты. Потом встраиваешь эту деятельности в процесс – и получается, что время есть. Тексты, как и тесты, помогают в понимании происходящего. Даже если выделять на статью по часу в день, она получится. Разумеется, в случае, если для человека это важно.

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

    Хочу написать статью на Хабр и даже тему придумал. С чего начать?


    Ничего нового в этой проблеме нет. Стивен Кинг, Джордж Оруэлл, Эдгар Аллан По, товарищи Стругацкие, дуэт Генри Лайон Олди, Ричард Фейнман и многие другие авторы в той или иной формулировке говорили:
    «Если вы хотите что-то начать (писать статью, книгу или письмо другу), но все никак не можете — нет времени и ситуации лучше, чтобы сделать это, чем… прямо сейчас!».

    Одним из нас помогает открыть текстовый редактор и вылить туда поток мыслей по теме. Скорее всего, потом окажется, что это «всё не то», но первый шаг сделан — работа над статьей началась.

    Есть и другой способ: найти другого сотрудника и рассказать ему о теме статьи. Причём начать рассказ со слов: «Ну, короче…». И как только полились первые мысли, с криком «Спасибо!» убежать к себе и срочно записать свой рассказ. Простыми словами, с производственными матами, который вы потом замените на что-то конструктивное.

    И на закуску способ от классика — строго под вашу ответственность.

    image

    Пишу, пишу, застрял. Что делать?


    Есть три варианта развития событий, который можно приложить к ситуации:

    • Выпить чайку и расслабиться. Уж точно не нужно себя заставлять, когда текст «не идёт» — ничего хорошего из такого превозмогания не получается. Это, кстати, касается не только написания статей.

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

      Делайте что-то вокруг текста, но не вымучивайте слова. Тогда мысли сами начнут роиться и нужно будет только ухватить их за хвост — и выложить, как есть, на бумагу/в текстовый редактор.
    • Сгребите весь материал в релиз статьи всё «как есть». В этот момент придется дописать основные мысли или логически завершить с выводом, что есть. Если это выглядит хорошо, то остальное можно сдвинуть в следующую статью.
    • Глубокий и длительный ступор может означать, что тема не близка, и писать про неё не надо. Такие темы лучше отсечь на первом этапе. Или посоветоваться с коллегой.

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

    В заключение


    Пишите. Никого не слушайте и пишите. Это хорошо. А хорошо будете писать – вообще отлично. И тогда хаброобщество будет умнеть, матереть и богатеть.

    Напоследок полезные ссылки на эту тему:


    Делитесь своими рецептами в комментах, ждем!
    • +11
    • 1,7k
    • 5

    EastBanc Technologies

    123,00

    Специалисты по цифровой трансформации бизнеса

    Поделиться публикацией
    Комментарии 5
      +2
      Начал писать короткий коммент, а в итоге накропал на целый поучительный пост.

      Нет ничего плохого в рекламе на хабре компаний или проектов (в конце концов, вы же тут этим и занимаетесь в своем корпоративном блоге, не так ли?). Важно только делать это правильно. У меня вот есть пара топиков, где по сути я рекламировал свои идеи и проекты, но тем не менее они набрали более сотни плюсов, вызвали бурное обсуждение и довольно долго провисели в топе. Да и что далеко ходить — я думаю любой вспомнит блоги Мосигры, или вот у тех же Туту в последнее время очень сильные статьи. Это ведь тоже реклама, только завернутая в правильную «хабрааоболочку».

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

      1. Выбрать какую-нибудь животрепещущую тему.

      Это, конечно, самое сложное. Тема должна быть с одной стороны массовой — чтоб каждый обитатель хабра мог примерить ее на себя. Рекламироваться сугубо техническими статьями неэффективно, они набирают мало просмотров и обсуждений. Но с другой стороны — она должна быть все-таки хоть чуть-чуть технической, чтобы не вызвать отторжения аудитории типа «что это делает на хабре?!». Например я вот рассказывал про уличную грязь и вытоптанные газоны, как можно их избежать с помощью компьютерной симуляции. Или про то как интересно скоротать время в незнакомом районе города, проложив интересный пешеходный маршрут с помощью придуманного мной алгоритма — близкие и понятные людям ситуации. Тема должна сама по себе провоцировать дискуссию и даже может быть немножечко холиварной (холивар в комментах это хорошо, это повышает число просмотров и продвигает тему в разделы «сейчас обсуждают»).

      2. Выбрать техническую хабраориентированную сторону

      Чтобы соответствовать тематике ресурса надо не просто описать проект, а расписать в нем что-то техническое (если вы конечно не Мосигра, им уже по-моему можно писать вообще про что угодно и все равно получать плюсы, хех). Поэтому хорошо заходят темы вида "%глобальная проблема%: как мы в %компания% решили ее с помощью %технология%. При этом с точки зрения популярности поста первичной будет именно «глобальная проблема», привлекающая аудиторию.
      В рекламном посте технические детали — это по сути просто «пропуск на хабр». На них можно не останавливаться в подробностях, но как минимум пара полезных нюансов должна быть указана. В итоге довольны будут все — читатели, не разбирающиеся в данной технологии, получат свои приятные впечатления от общей проблемы и общих слов, а технически подкованные — все-таки найдут для себя что-то полезное и поставят в голове галочку «статья не пустопорожний треп, а есть и что-то по делу».

      Тут самое главное — нащупать баланс между «болтовня ни о чем, написанная хреновым копирайтером, что это делает на хабре?!» и «хардкорные технические нюансы, интересные 1% аудитории». По опыту — у многих корпоративных блогов с этим проблемы, перекос либо в первую сторону (такие блоги правда обычно долго не живут, т.к. отхватвают минусов в карму и теряют аудиторию) или во вторую. Вот ваш блог например — вижу что темы полезные для специалистов, но слишком технические, в итоге просмотров всего 3-4к, что по меркам хабра совсем немного, если ставить целью именно рекламировать себя, а не просто бескорысно делиться знаниями.

      3. Собственно красиво написать. Интригующий заголовок и КДПВ, сходу раскрывающие тему очень помогают — ведь только заголовок будет виден людям в блоках типа «интересное» и «сейчас обсуждают». С красивыми фотографиями (если они конечно применимы к вашей теме). С понятным текстом и минимумом маркетингового буллшита (упомянутый в посте glvrd.ru в этом плане очень неплохо помогает), который может прокатывает в других местах, но очень бесит здешнюю аудиторию. Хорошо если будет какая-то живая история — это опять-таки позволит людям не заскучать от технических деталей и дочитать статью до конца.

      В общем как-то так я стараюсь писать, и хотя многие мои посты по сути рекламные — заходят аудитории они, как мне кажется, неплохо.
      Повторюсь, речь именно о написании постов с целью собрать максимум просмотров и откликов. Посты-«шпаргалки» с конкретными полезными рецептами и алгоритмами, на которые люди приходят из гугла в поисках нужного куска кода, отлично обходятся без всего этого.
        +1
        Мне кажется статья немного шире, чем вы описываете. Она касается не столько «как написать статью, чтобы было много плюсов и просмотров», а касается мотивации, того что компания хотела бы донести и как разработчикам начать писать.
        «Выбрать какую-нибудь животрепещущую тему» это здорово, но как из повседневных задач сделать такую животрепещущую тему? А о повседневных задачах нужно писать, чтобы все знали, что не в бирюлки играем, а реальные дела делаем :)

        А вообще хороший челлендж, написать статью с большим количеством просмотров и лайков, надо попробовать поставить именно такую цель :)
          0
          Выбрать какую-нибудь животрепещущую тему» это здорово, но как из повседневных задач сделать такую животрепещущую тему

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

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

          +1
          Спасибо за рекламу hackmd, похоже вещь просто оболденная!

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

          Самое читаемое