В 2021 году я присоединился к техническому письму, где написал около 20 платных технических статей и заработал в Интернете более 6 тысяч долларов.
По моему опыту, написание хорошей технической статьи — это не прогулка по парку. Хорошая техническая статья — это статья, в которой сложные концепции излагаются простым и понятным языком.
Как технический писатель, чтобы разбить сложные концепции на простой и понятный язык, вам необходимо:
- Во-первых, разберитесь в теме, о которой вы пишете.
- Во-вторых, знайте аудиторию, для которой вы пишете.
- В-третьих, знайте, как структурировать статью, чтобы донести свое сообщение до читателя.
- Наконец, знайте, как использовать правильный голос и тон в своем письме.
Чтобы сделать все вышеперечисленное, вам нужен хороший процесс технического письма.
В этой статье вы узнаете о процессе написания технических текстов, который я использую, чтобы писать более качественные технические статьи для своих клиентов.
Вот этапы процесса технического написания, которые я буду освещать:
- Шаг 1: Исследование.
- Шаг 2: Подготовьтесь к написанию.
- Шаг 3: Напишите первый черновик.
- Шаг 4: Обзор.
- Шаг 5: Редактирование.
- Шаг 6: Утверждение и публикация.
Шаг 1: Исследование
Во-первых, выполните поиск в Google по теме, о которой вы пишете. Затем просмотрите статьи по теме. Когда вы просматриваете статьи, делайте заметки, чтобы лучше понять тему.
Кроме того, вы можете спросить ChatGPT по теме. Затем сравните информацию, которую вы получаете от ChatGPT, с информацией, полученной от поиска Google.
Например, на этой неделе я начал работать над новой темой для клиентской технической статьи. Вот заметки, которые я сделал, исследуя тему.
Примечание. Вам необходимо сравнить информацию из ChatGPT с информацией из поиска Google, потому что ChatGPT иногда может предоставлять неточную информацию.
Во-вторых, определите формат и структуру темы, о которой вы будете писать.
Типы структур статей
В технических блогах есть два типа технических статей.
- Процедурные статьи: в этих статьях читатель шаг за шагом знакомит читателя с выполнением задачи.
- Концептуальные статьи. Эти статьи помогают читателям глубже понять тему и заложить основу для дальнейшего обучения.
Ниже представлены разные структуры статей.
В-третьих, определите целевую аудиторию темы, о которой вы будете писать.
Самый простой способ определить вашу целевую аудиторию — это определить, чему она должна научиться.
Напишите список всего, что вашей целевой аудитории нужно изучить в технической статье, которую вы будете писать.
Шаг 2: Подготовьтесь к написанию
Во-первых, определите цель или цель статьи, которую вы будете писать.
Определение вашей аудитории на первом этапе поможет вам определить цель статьи.
Цель статьи может заключаться в том, чтобы помочь читателю узнать что-то или решить проблему. Вот пример цели статьи.
Во-вторых, создайте план статьи.
Набросок, говоря простым языком, представляет собой скелет готового текста, в котором отображаются темы, которые вы затронете в статье.
План обеспечивает структуру, которая обеспечивает логичное и ясное изложение ваших идей.
Определение формата и структуры статьи на первом этапе поможет вам создать план статьи.
Например, вот план статьи, которую я написал для блога DbVisualizer.
Примечание. После определения цели статьи и создания плана, если это работа клиента, вы можете отправить статью клиенту, чтобы получить обратную связь, чтобы убедиться, что вы находитесь на той же странице.
Шаг 3: Напишите первый черновик
Во-первых, укажите цель статьи в названии. Ниже показано, как можно отформатировать этикетку.
Формат заголовка
Как «выполнить задачу» с помощью «программного обеспечения или технологии»
Пример
Как создать калькулятор с помощью JavaScript
Во-вторых, начните писать введение к статье. Введение каждой статьи должно состоять из 1-3 абзацев.
Вопросы, на которые должно ответить хорошее вступление
- Какая проблема решается?
- Каково решение этой проблемы?
- Что узнает читатель?
В-третьих, напишите предпосылки. Цель предварительных требований – указать точно, что читатель должен иметь или сделать, прежде чем он будет следовать текущему руководству.
Формат представляет собой список, который читатель может использовать в качестве контрольного списка. Каждая точка должна быть связана с существующим учебником, который охватывает необходимый контент, или официальной документацией по программному обеспечению.
Это позволяет вам полагаться на существующий контент, о котором известно, что он работает, вместо того, чтобы начинать с нуля.
В-четвертых, начните писать текст статьи поэтапно. Шаги — это части вашей статьи, в которых вы описываете, что читателю нужно сделать и почему.
Шаг содержит команды, списки кодов и файлы, поясняющие, чтонужноделать и почемувыделаетеэтоэтотспособ.
Наконец, напишите вывод статьи. Заключение статьи должно обобщать то, что читатель узнал или достиг, следуя вашему руководству.
Шаг 4: Проверка первого проекта
После написания первого черновика отправьте его клиенту, эксперту в предметной области или кому-то, кто хорошо разбирается в теме, о которой вы пишете, для рецензирования.
Рассмотрение черновика клиентом или экспертом в предметной области гарантирует, что статья технически точна и соответствует цели статьи.
Шаг 5: Редактируйте и пересматривайте
Редактирование и пересмотр — это когда вы превращаете проверенный черновик в окончательный черновик. Обязательно делайте перерыв между написанием и редактированием. Перерыв позволит вам взглянуть на свою работу свежим взглядом.
Вы можете использовать такие инструменты, как Grammarly, в процессе редактирования, чтобы проверять орфографические, грамматические, стилистические и пунктуационные ошибки.
Шаг 6: Корректура и утверждение окончательного проекта
Вычитка окончательного варианта — это когда вы закончили писать, но не готовы опубликовать его или передать клиенту на утверждение.
Здесь вы просматриваете свою статью, чтобы поймать:
- Любые орфографические ошибки
- Грамматические ошибки
- Опечатки
- Ошибки форматирования
- Неверная структура или синтаксис
После проверки окончательного варианта отправьте его клиенту для последнего рассмотрения и утверждения.
Шаг 7: Опубликуйте готовую статью
Клиент опубликует статью, если в окончательный вариант больше не будут внесены изменения. Если это личная статья, вы можете опубликовать ее в своем блоге или на бесплатных блог-платформах для разработчиков, таких как:
- Середина
- Разработчик
- Хашнод
Заключение
В этой статье вы узнали, как шаг за шагом написать хорошую техническую статью. Если вам понравилась статья, подписывайтесь на меня в Твиттере, чтобы получать ежедневные советы по техническому письму.
