Как писать хардкорные статьи, чтобы их читали

Как ни крути, хардкорные статьи — соль Хабра. Они вдохновляют, обучают, информируют, разъясняют и задают высокую планку уровня публикаций. Их пишут легенды (как по значку в профиле, так и по жизни), известные тимлиды, уверенные мидлы и круто въехавшие в тему джуны (которые порой и не джуны вовсе). Их читают не все. А ещё к ним очень страшно подступиться. Попробуем разобраться, как писать супер сложную статью, чтобы она осталась в анналах истории, Хабра и в закладках самых строгих читателей. 

2e3f1f09c26a4d3a9b6cb24b096673b0.png

Как писать

Простая подача

Как ни парадоксально, писать на хардкорные темы крайне просто и максимально сложно одновременно. Дело в том, что у этого процесса две стороны:

  1. если автор взялся за сложную техническую статью, он точно знает, о чём пишет — у него есть знания, опыт, навык, примеры, бенчмарки и, что важно, мотивация (отдельных «героев», готовых писать абы о чём, мы рассмотрим как статистическую погрешность, которой можно пренебречь);

  2. но автору предстоит рассказать о своей теме широкой аудитории с разным уровнем подготовки, и тут возникает дилемма: писать на «заумном» языке для узкого круга специалистов или же выбрать доступный язык, добавить информацию для «новичков», дополнительно «разжевать» материал  и расширить аудиторию в несколько раз. 

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

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

Оформление

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

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

  • Оформляйте код красиво: он должен быть «живым» (не скриншоты), с соответствующей подсветкой синтаксиса, необходимыми и уместными комментариями. В общем, таким, каким бы вы сами хотели его видеть на своём идеальном проде.

  • Позаботьтесь о КДПВ и изображениях в тексте: выбирайте парадоксальные картинки, которые привлекут внимание, но при этом соответствуют теме (ирония, сарказм, грамотно выбранные аналогии и мемы) или строго тематические изображения (чтобы сразу было понятно, о чём идёт речь).

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

Оживите текст

Каким бы сложным ни был текст, всегда есть возможность сделать его живее с помощью несложных приёмов.

  • Юмор — ему всегда есть место. Даже если вы пишете про краши и факапы (особенно если вы пишете про краши и факапы). Главное, не переборщить с юмором и использовать его дозированно и органично. О юморе мы писали в нашем канале для авторов. 

  • Литературные приёмы, которые делают текст эмоционально насыщенным, ярким, читабельным даже для простых смертных, не только экспертов. Подробнее о приёмах здесь. 

  • Формат подачи — подумайте над форматом и выберите стиль, форму и структуру таким образом, чтобы она облегчала восприятие и не мешала работе основной информации в тексте. На Хабре были испытаны десятки форматов, от анекдотов и мемов до стихов, — среди них немало по-настоящему удачных. Кстати, надуманный и неподходящий формат максимально просто определить: вам будет трудно его писать, он будет идти со скрипом. Когда попадаешь с подачей в точку, текст пишется ощутимо быстрее (по моему опыту, почти в полтора раза). 

  • Образ автора в тексте при разумном использовании — выигрышная история: вы сразу демонстрируете себя и как эксперт, и как спикер, и как человек. Не бойтесь быть человеком, показать эмоции, переживания, а может быть, местами и характер. Это только привлечёт читателей, поскольку они ощутят себя в состоянии диалога с автором.

Подходящие форматы

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

  • Туториалы — классические публикации, в которых автор детально разбирает выбранную технологию. Пользуются популярностью, поскольку к ним постоянно обращаются пользователи, их ищут, добавляют в закладки, под ними в комментариях пишут важные дополнения и замечания. Отличный формат для серьёзных и вдумчивых авторов, готовых делиться знаниями и опытом. Не нередко бывает, что классные туториалы получаются и у начинающих специалистов, которые круто разобрались в теме и готовы рассказать о своём пути к пониманию.

  • «Кишочки» — хардкорные тексты от опытных авторов, в которых раскрываются самые сложные внутренности технологии, рассматриваются детали и нюансы, описываются неожиданные особенности архитектуры, странные баги, внезапные фичи и многое другое. Такие публикации пишут опытные практики, которые уже всё «пощупали» руками и мозгами и которым важно обсудить это с сообществом. Настоящие хиты для узкой профессиональной аудитории. 

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

  • Практические кейсы — редкие птицы в технохардкоре, потому что самые крутые проекты чаще всего под NDA. Однако рассказы об обезличенном фрагменте проекта, о пет-проекте или какой-то энтерпрайзной истории со всеми взлётами, провалами и аналитикой отлично заходят аудитории и сразу «высвечивают» фигуру автора. Один из лучших форматов для прокачки личного бренда и заявки на участие в крупных конференциях. 

  • Хобби-проекты — прикольные DIY или просто разработческие истории, которые раскрывают уровень автора, служат учебным материалом и которые просто интересно читать.

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

  • Шпаргалки — классный формат, производный от туториала. Информация в них хорошо структурирована, легко и грамотно подана. Шпаргалки могут быть учебными, практическими, наборами вопросов-ответов для собеседований и т. д. Опять же, если вы берётесь кого-то чему-то учить или что-то систематизировать, цена ошибки внутри публикации многократно возрастает.

  • Статьи-ответы и статьи-расширения. Автор А пишет статью на тему Х, автор Б развивает тему Х, как бы отвечая автору А и ссылаясь на него, автор В добавляет свой опыт и пишет об Х, автор Г добивает дискуссию и разносит всех предыдущих :-) Ну то есть любая цепочка обсуждения технологии или проблемы. Тут главное соблюдать этикет и не забывать делать ссылки на предыдущие статьи. 

  • Чек-листы — публикации, больше подходящие для инженерных тематик, но и в тестировании и разработке выглядят выигрышно. Всегда любимые аудиторией, если составлены с головой и со знанием дела. Формат простой: сделал это — получил это — следующий шаг. Максимально практически значимы. 

  • Качество кода (анализ, разбор, рефакторинг, ревью) — редкий вид публикаций, почти монополизированный на Хабре компанией PVS-Studio. Интересный и полезный формат, где можно разобрать код стажёра, легаси-код проекта или свой собственный. Всегда полезный и погружающий в себя материал. Идеально подходит для любых языков программирования. Его преимущество в том, что вы можете не рассказывать о проекте, не делиться подробностями, а просто рассмотреть основные ошибки, находки, паттерны и пояснить за совершенный код :-)

  • Бубнёж — расскажите, что вы опытный программист, работодатели не умеют обеспечивать управление разработкой, HR не разбираются в подборе, а на собеседованиях дают сплошь безграмотные технические задачи (и вообще их быть не должно, потому что вы опытный сеньор, а работодатели не умеют…). Думаю, вы поняли, о каких авторах идёт речь. Бубнёж aka критика aka «как страшно жить в ИТ» заходят хорошо, но только если автор бубнит по делу и аргументирует свою позицию. Простое нытьё аудитории поднадоело и скорее вызовет волну негатива. 

Пять сомнений авторов

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

1. Кому интересен мой опыт…

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

2. Ну я в Oracle не работал, JVM не писал…

Вполне возможно, вы работаете в небольшой компании, которая пилит весьма серьёзный софт в режиме экстремального или парного программирования. А может, вы пишете крутые конфигурации на 1С? Или вы дорабатываете чужой корпоративный софт и проводите внедрения? А вдруг вы запилили классное приложение, которое пылится в репозитории? Во всех этих случаях вы гораздо интереснее, чем предсказуемые крупные команды с регламентированной разработкой — у вас по-настоящему уникальный опыт. Делитесь подробностями, вас на Хабре не хватает. 

3. Да у меня тут такой проект, любительский

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

4. Всё написано до меня!

Напоминаю про формат статей-ответов и статей-расширений. Ваш опыт — это только ваш опыт, со своими деталями, находками и ошибками. Расскажите о нём, обсудите его с аудиторией, обменяйтесь уровнем знаний и опытом. Ну и кроме этого, технологии имеют свойство обновляться и вполне возможно, что ваш опыт из 2022–2023 совершенно другой, чем у автора такой же темы из 2015.

5. Я не хардкорный автор (я не имею право рассказывать и т. д.)

Честно говоря, профессиональных хардкорных авторов очень мало, и их авторство основано на огромном опыте, знании темы, обучении и т. д. На Хабре важен опыт, практика и знания в технической сфере. Авторские скилы — вторичны. Если вам нужна редакторская помощь, пишите на neo@habr.team (мы, кстати, себя тоже хардкорными авторами не считаем, хотя за плечами немало сложных публикаций). Синдром самозванца никого не обходит :-)

Примеры в студию

Примеры удачных публикаций из хаба Java (Почему из него? Да сезон у нас идёт, сезон Java one love! Если вам есть что сказать — срочно беритесь за перо клавиатуру.)

  1. Дайте крудошлепа / Хабр — захватывающий стиль автора. Даже если ты нифига не смыслишь в описанных технологиях, ты не просто следишь за текстом автора и сопереживаешь ему, но и понимаешь, о чём он пытается сказать.

  2. Глубокое погружение в Java Memory Model — умный (но не заумный) текст про сложные технические нюансы; для неискушённого читателя — скучно, для вовлечённого — разговор с автором как с другом на равных.

  3. Большой гайд. Пишем микросервисы на Java и Spring Boot, заворачиваем в Docker, запускаем на EKS, мониторим на Grafana — внятный структурированный туториал, который может быть полезным разработчикам всех уровней. Потому что Олег Чирухин @olegchir постиг дзен Хабра и круто шарит в теме.

  4. Как поместить весь мир в обычный ноутбук: PostgreSQL и OpenStreetMap — отлично разобранный практический кейс, который демонстрирует возможности стека и навыки автора. Всё сошлось.

  5. Сказка о типизации — талантливая подача сложной темы. Отличный текст, который прикольно прочитать даже тем, кто «мимопроходил».

  6. Java байткод «Hello world» / Хабр — статья-дополнение к предыдущим с интересным опытом автора. 

  7. Размеры массивов в Java — ещё один пример того, что настоящему профессионалу всегда есть что сказать по теме. 

  8. Как создать игру, если ты ни разу не художник — захватывающая история пет-проекта, которая «работает» на всех: начинающие ребята найдут мотивацию, опытные — предмет для обсуждения и интересный проект, непрофессионалы — крутую историю разработки, которая читается, как захватывающий рассказ.

  9. Кто создал Java: главное про Джеймса Гослинга — историческая статья. Кстати, довольно сложный формат с точки зрения подготовки материала, отработки фактуры и проведения фактчекинга. Вариант для максимально широкой аудитории. 

Впереди выходные. Так что, если вам есть что сказать по любой теме, пишите на Хабр и в Песочницу (у нас срок одобрения в общем случае сократился до 1 дня). Если есть что сказать по теме Java, то можно ещё и заработать (ноутбук, деньги, авторитет). 

Делитесь своим опытом или авторскими страхами в комментариях — обсудим и постараемся помочь. 

Спасибо за внимание!

© Habrahabr.ru