Обычно программисты пишут статьи об экспериментах, личном опыте, информационных и компьютерных технологиях. Другие создают учебные руководства по новейшим фреймворкам и инструментам. А некоторые любят писать о сложных концепциях и информатике. Такие публикации относятся к техническим статьям, потому что они помогают разработчикам повышать профессиональный уровень.
С помощью различных стратегий каждый автор пытается увеличить количество прочтений и просмотров своего контента. Однако ни одна техническая статья не может стать настолько популярной, чтобы ее прочитали тысячи и миллионы разработчиков. Значительно увеличить количество просмотров, практически в геометрической прогрессии, позволяют повторные публикации. При этом основой успеха технической статьи несомненно является высокое качество содержания.
Я начал писать технические статьи около двух лет назад, и сейчас на Medium их просмотрели почти миллион раз. Чтобы увеличить количество просмотров контента, я пробовал разные стратегии и выявил наиболее эффективные и полезные из них.
Статья как обозрение
Любая статья состоит из трех основных частей: введения, основного текста и заключения. Программистам также необходимо разбивать статьи на три части для логичности изложения. Хорошо помогает при этом представление будущей статьи в виде обзора. Сначала можно представить во введении тематику статьи. Другими словами, начать можно с общего объяснения, без лишних деталей. Например, если вы пишете о разработке настольных приложений Flutter, то ввести читателя в курс дела позволят несколько общих слов о разработке настольных приложений.
Возьмем другой пример. Эта статья начинается с особенностей создания технического контента. Из первых строк читатель понимает, о чем пойдет речь, и видит пользу. В противном случае, он может просто закрыть ее.
В короткой статье можно обойтись и без заключения, но в остальных случаях оно играет важную роль. Например, если вы рассматриваете альтернативы фреймворку Electron, то в заключении следует резюмировать, почему они столь же актуальны, как и сам Electron. Кроме того, будет замечательно, если увязать с темой статьи последний абзац.
Приводите больше примеров
Несомненно, добавление примеров — это хороший прием для непринужденного объяснения. Технические статьи часто включают теоретические разделы, которые могут утомлять читателя. Чтобы удержать его внимание до конца статьи, добавляйте практические примеры. Они помогут быстрее разобраться в незнакомой технологии. Кроме того, примеры — это одна из стратегий, подтверждающих верность высказываний автора. Рассмотрим в этом качестве следующие утверждения:
«Крупные технологические компании обычно выбирают платформу Electron для создания масштабных настольных приложений. Например, Microsoft выбрала Electron для Visual Studio Code, Skype и Teams».
Каждому разработчику известны эти программы. Таким образом, он действительно поверит утверждению в первом предложении. Но избыток примеров делает статью мало информативной. Поэтому нужен баланс между примерами и основным содержанием.
Вызывайте любопытство, но в конце отвечайте на все вопросы
Интересный заголовок, подзаголовок и введение хорошо помогают заинтриговать читателей. Программисты часто выбирают броские заголовки, чтобы привлечь их внимание.
Недавно я увидел статью под названием «Прекратите использовать console.log в JavaScript». После прочтения заголовка у читателя могут возникать разные предположения. Некоторые программисты могут подумать, что речь идет об отладчике браузера. А кто-то будет предполагать, что статья о других полезных функциях Console API. Все будут заинтригованы предложением прекратить использование функции console.log.
Вы точно так же можете вызывать у читателя любопытство, но в конце статьи следует честно ответить на все вопросы. Читатель должен получить ответы на все вопросы. Например, если вы утверждаете в статье, что какой-то фреймворк плохой, то это следует наглядно показать. В противном случае, чтение статьи вызовет массу вопросов, на которые читателю придется искать ответы в другом месте.
Дополнительные пояснения
Изучая составляющие систему модули, каждый программист стремится узнать, как она работает. Поэтому стоит добавить практические указания для каждого описываемого шага. Если какой-либо этап включает фрагмент кода, то следует добавить несколько слов с комментариями каждой строки. Кто-то скажет, что каждый программист может и сам разобраться с кодом без детальных пояснений. Но среди читателей могут быть и начинающие специалисты. Новички ежедневно просматривают множество контента, чтобы усовершенствовать свои навыки в программировании.
Поэтому в технической статье нужно объяснять каждый шаг описания. Примером служит следующий текст о разработке приложений Angular:
«Для создания нового приложения Angular можно использовать команду
ng new. Эта команда задаст несколько вопросов и создаст исходные файлы для нового приложения».
Подробные и полные объяснения помогут сделать материал интересным для всех разработчиков. Постарайтесь полностью раскрыть тему статьи и объяснить каждый шаг повествования, чтобы охватить весь круг заинтересованных читателей.
Посмотрите на статью глазами читателя
Это очень важно для создания успешной технической статьи. Людям свойственно ошибаться. Иногда мы можем нечетко формулировать мысли, пропускать важные знаки препинания, использовать неправильное форматирование. Написанные без ошибок статьи чаще читают полностью. Чтобы обнаружить эти ошибки, прочтите готовую статью 2–3 раза глазами читателя. Попросите проверить ее кого-нибудь из близких друзей.
Прежде чем отправлять статьи на редактуру, я обычно читаю их как минимум три раза. После этого прошу кого-нибудь просмотреть их еще раз. Напоследок я прослушиваю аудиоверсию статьи. Кроме того, важно удостовериться, что каждое предложение приносит ценность для читателя.
Заключение
Чтобы написать содержательную статью, авторы применяют ряд методик. Секрет любой успешной технической публикации заключается в четком и полном раскрытии темы с хорошим форматированием. Вышеперечисленные советы станут руководством для создания хорошего контента.
Объяснение сложных концепций иногда дается непросто. Однако хорошо структурированная, упорядоченно и качественно поданная информация позволит объяснить сложную тему любому программисту.
Читайте также:
- Основы написания мануалов при разработке
- Первые шаги в программировании: работа без ошибок
- Мои заметки по программной инженерии
Читайте нас в Telegram, VK и Яндекс.Дзен
Перевод статьи Shalitha Suranga: 5 Ingredients of a Successful Technical Article
