Создание собственного технического блога

Советы и приемы для создания портфолио технического письма

Я люблю писать. Я пишу с 2012 года на различных платформах, включая Blogger, Wordpress, dev.to, Hashnode и т. Д., По темам, включая NodeJS, JavaScript, безопасность, продуктивность разработчиков. Я чувствую, что ведение блога сделало меня лучше письменным коммуникатором, а также лучшим разработчиком, чем я, с точки зрения технических знаний, жажды знаний и любопытства к тому, как все работает под капотом.
Из полученных мной ответов и Благодаря статистике Medium (просмотры, соотношение просмотров и прочтений, хлопки и т. д.) за последние пару лет я научился нескольким трюкам с точки зрения структурирования статьи и передачи идеи. Хотя мне еще есть чему поучиться и улучшить, я подумал о том, чтобы поделиться тем, что я узнал до сих пор, и своим подходом к написанию технического контента. Хотя я мог бы использовать некоторые ссылки, связанные с Medium, это руководство не обязательно ограничивается написанием на Medium.

Зачем писать…

У меня не самая лучшая память. Итак, я начал писать то, что узнал, чтобы освежить свою память на случай, если я забуду то, что узнал. Да, это отличный повод написать. Я часто пересматриваю свои собственные статьи, чтобы вспомнить определенные темы, которые я больше не помню. Кроме того, есть еще пара причин, по которым письмо может быть полезно для вас.

  • Отзывы читателей. Положительные / отрицательные отзывы, а также последующие вопросы ваших читателей неоценимы для обучения. Иногда у читателей возникают вопросы, на которые вам нужно узнать еще больше, чтобы на них ответить.
  • Обратитесь к собственному письму позже.
  • Улучшает ваши письменные навыки. Написание технических материалов улучшит ваши письменные коммуникативные навыки. Это поможет вам четко и кратко объяснить технические вопросы другим пользователям в документации, электронных письмах, чатах и ​​т. Д.
  • Подходит для вашего профиля. Наличие собственного блога или портфолио технических писателей определенно поможет вам выделиться. Это поможет вам еще больше и привлечет больше внимания, если вы тщательно спланируете свое письмо, чтобы охватить востребованные, но менее документированные темы.
  • Поддержите сообщество, в котором вы процветаете. Сколько технических руководств, сообщений в блогах и статей вы прочитали за свою карьеру? Пришло время поделиться тем, что вы знаете, и помочь кому-то вроде вас.

Что писать и как писать…

У каждого свой стиль письма. Вот мой подход к написанию новой статьи.

  • Выберите хорошую тему - Интернет огромен. Поэтому не беспокойтесь о том, что у вас нет какой-то уникальной темы, о которой можно было бы написать. Независимо от того, насколько уникальным мы можем считать нашу статью, всегда возможно, что где-то в Интернете есть похожий контент. Тем не менее, если вы напишете что-то менее распространенное, но пользующееся спросом, вы, вероятно, привлечете больше людей.
  • Создайте черновой план. После того, как вы выбрали тему для написания, сначала создайте черновик, а затем наметьте разделы и подразделы, которые нужно заполнить позже. Это можно сделать исходя из того, что у вас в голове, и не обязательно быть окончательным планом статьи.
  • Потратьте много времени на изучение. Когда черновик плана готов и вы знаете, о чем хотите написать, начинайте исследование по теме. В моем случае я обращаюсь к как можно большему количеству ресурсов по теме и пытаюсь получить достаточно глубокое понимание предмета. Чем больше вы исследуете, тем больше у вас будет вопросов, которые заставят вас узнать еще больше. Глубокое понимание темы поможет вам написать краткую статью и ответить на вопросы, которые могут возникнуть у читателей.
  • Напишите. Закончив исследование, проверьте, актуален ли ваш план. Если нет, измените его и получите окончательный план. После этого заполните разделы и подразделы тем содержанием, которое вы хотите написать. Я бы не стал слишком беспокоиться об опечатках, грамматике, понятности и том, насколько подробно я пишу на этом этапе. Цель состоит в том, чтобы просто заполнить разделы и подразделы и получить полный черновик.
  • Уточнение, уточнение, уточнение. Пришло время уточнить свое описание. Прочтите статью от начала до конца с точки зрения читателя и исправьте все опечатки и грамматические ошибки. По мере чтения вы обнаружите в статье непонятное содержание. Попробуйте перефразировать этот контент или добавить больше деталей, чтобы четко передать суть. Сделайте это несколько раз, пока не будете уверены, что он готов к публикации. Также было бы неплохо, если бы вы могли попросить кого-нибудь вычитать его перед публикацией.

Чего не следует делать…

  • Слишком подробно. Если статья слишком длинная и подробная, очень вероятно, что читатели потеряют интерес к ее прочтению на полпути. Группа специалистов по продуктам Medium на основе статистики вовлеченности читателей выяснила, что оптимальная продолжительность публикации - 7 минут. Но это не значит, что вам не следует писать более длинные статьи. Вы можете использовать фрагменты кода, диаграммы, графики, изображения, GIF-файлы и т. Д., Чтобы читатель был вовлечен в длинную статью.
  • Излишне разбитые на несколько частей - я видел много случаев, когда авторы Medium были слишком сосредоточены на зарабатывании денег, поэтому без необходимости разбивали свои статьи на серию очень маленьких статей, таких как Часть 1, Часть 2. и т.д. Это делает каждую отдельную часть серии статей бесполезной. Это не принесет вам какой-либо значительной краткосрочной денежной выгоды, но только повредит вашему профилю в долгосрочной перспективе.
  • Только текст. Не секрет, что читатели, скорее всего, будут больше интересоваться статьей (больше подписчиков, больше прочтений и больше хлопков), если она содержит визуальные элементы, такие как диаграммы, графики, изображения и т. д. За текстовыми статьями очень трудно следить, и они утомительны, особенно если они слишком длинные. Если вы встраиваете фрагменты кода, убедитесь, что они короткие и понятные. Кроме того, было бы лучше встраивать фрагменты кода в «красивом» формате с помощью GitHub gists или аналогичного инструмента, а не вставлять их напрямую.
  • Заголовки кликбейтов - канал переполнен заголовками кликбейтов. Нет ничего плохого в том, чтобы начинать заголовок статьи со слов «5 вещей, которые вы должны…», «10 главных вещей, которые вы должны…» и т. Д. Но если вы это сделаете, убедитесь, что ваша статья действительно стоит посещения читателем. Если контент такой же пикантный, как и заголовок, люди, скорее всего, будут подписываться на вас и привлекать больше внимания. Clickbaits могут навредить вам в долгосрочной перспективе и испортить ваше портфолио. Они могут раздражать читателей и отталкивать их от вашего будущего контента.

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