Дорожная карта технического письма

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

Прослушайте запись

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

Прежде всего, я не люблю дорожные карты. Они безличны, не добавляют ценности и могут сбить вас с толку.

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

Так что давайте рассматривать эту статью как руководство, а не дорожную карту, хорошо?

Ответьте на вопрос «почему

Чтобы помочь себе заняться техническим письмом, вам следует сначала ответить на следующий вопрос:

Почему вы хотите стать техническим писателем?

Ответ на этот вопрос поможет вам определить, на чем сосредоточиться и как действовать дальше.

Давайте рассмотрим некоторые распространенные ответы:

  • Я не знаю, но я видел, что все остальные этим занимаются.

Если вы ответили именно так, знайте, что можно им не становиться! Быть техническим писателем не обязательно, если вы являетесь разработчиком.
Вы должны заниматься техническим письмом только в том случае, если вам это нравится.

  • Я хочу улучшить свои навыки письма

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

  • Я хочу лучше понимать технологии

Это был мой основной подход. В своей повседневной работе я работаю в основном с React, но у меня по-прежнему есть огромная страсть к изучению других технологий. Мой блоггинг позволяет мне исследовать и писать об этих различных технологиях.
Основное внимание здесь должно быть сосредоточено на том, чтобы получать удовольствие от создания проектов и находить свой тон голоса, чтобы объяснять вещи по-своему.

  • Я хочу зарабатывать этим деньги

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

  • Я хочу, чтобы люди видели, что я могу объяснять сложные темы

Для некоторых людей их технические статьи могут стать ценным активом в их онлайн-портфолио.
Возможно, вы захотите использовать свои статьи, чтобы показать, что вы можете объяснять сложные темы так, чтобы это находило отклик у людей.
Если это вы, сосредоточьтесь на написании глубоких качественных статей, которые поражают людей.

Как

После того как вы определили, почему вы хотите стать техническим писателем, необходимо рассмотреть, как им стать.

И это может стать для вас неожиданностью:

Вы должны писать!

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

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

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

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

Написание статьи

Давайте рассмотрим несколько советов, которые помогут вам написать первую статью.

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

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

Как только у вас появятся заголовки, вы будете готовы на 50%. Тяжелая работа закончена. Идите и наслаждайтесь кофе/чаем или водой 🙏.

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

Полировка статьи

Когда статья готова, она может быть не идеальной.
В ней могут быть орфографические ошибки. Она может быть неаккуратной.

Давайте начнем с самых простых ошибок.

Прогоните статью через Grammarly и Hemingway. Это отличные приложения, которые помогут вам исправить грамматические ошибки в статье.

После этого откройте готовый продукт в локальной программе для чтения и прочитайте его самостоятельно.

  • Хорошо ли она написана?
  • Имеют ли ваши тезисы смысл?
  • Стоит ли добавить несколько изображений, чтобы сделать статью более привлекательной?

Если вы затрудняетесь с этими вопросами, вы можете даже попросить кого-то из своих друзей вычитать их за вас.
(Убедитесь, что они знают технические термины).

Доработайте некоторые основные моменты, но не стремитесь к совершенству.
Вы также сможете найти ошибки в своей статье. Таким образом, идеальных статей не существует.

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

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

Где публиковать

Однако большинство из вас, скорее всего, будут публичными авторами, и это прекрасно.

Итак, как только вы решили, что хотите опубликовать свою статью, необходимо определить, как и где вы будете ее публиковать.

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

Да, звучит безумно, верно, но все так делают 🤦♂️.

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

Поэтому вместо того, чтобы создавать свою блог-платформу с нуля, выберите что-то уже созданное.

Некоторые варианты:

  • dev.to
  • hashnode
  • ghost
  • wordpress

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

Выбрав один из вариантов, приступайте к публикации статьи!
Не бойтесь, что она будет отстойной, и пусть все знают, что вы написали свою первую статью.

Техническое сообщество приветствует новых авторов; большинство из них будут рады прочитать вашу статью и сообщить вам свои мысли.

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

  • Вы не объяснили что-то четко?
  • Вы допустили техническую ошибку?
  • Вы забыли необходимое условие?

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

Заключение

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

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

Кроме того, не увлекайтесь созданием платформы, поскольку уже существует множество отличных платформ.

И последнее, но не менее важное: Получайте удовольствие от написания!

Еще немного информации в статье Секрет моего писательского процесса

Спасибо, что прочитали, и давайте общаться!

Спасибо, что читаете мой блог. Не стесняйтесь подписываться на мою рассылку по электронной почте и общаться на Facebook или Twitter.

Оцените статью
devanswers.ru
Добавить комментарий