Найти тему
voiti-it

6 советов начинающему техническому писателю

Оглавление

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

– А можно по-другому, легче?

– Отчасти, да.

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

Все рекомендации взяты из моего богатого личного опыта: непосредственно работы по созданию текстов и обучения других сотрудников.

1. Анализируй чужие работы и пробуй их копировать

Конечно, речь не про плагиат и CTRL+C/CTRL+V, а про подражание. Пока ты не умеешь создавать контент с нуля, возьми за основу статьи по интересным техническим темам:

  • Найди тематический ресурс или несколько, анализируй содержимое статей и подмечай удачные и неудачные моменты.
  • Ищи сходства и различия в структуре текстов. Пробуй примерить их на свою тему.
  • Если первой темы пока нет, придумай. Рано или поздно придется начинать писать.
  • Обращай внимание на детали – достаточно ли этого для читателей или нет.

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

2. Пробуй писать

Делайте это по чуть-чуть, но каждый день. За неделю старайтесь закончить 1 статью.

-2

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

Вспомни, как ты учился чему-то новому в последнее время: сначала получается кривенько и медленно, но спустя N часов практики уже достаточно быстро и хорошо.

3. Выработай схему работы и придерживайся её

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

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

Разработай свою стратегию или возьми мою (я написала о ней в последнем посте в своем Инстаграм), набей на ней руку и дальше работай без постоянной проверки своих действий. На самом деле, и дальше ты продолжишь работать по плану, просто теперь это будет на автомате.

4. Оформляй

Мало написать хороший текст с точки зрения содержания. Его нужно ещё и хорошо оформить: это влияет на читабельность и успешное усвоение информации.

Основные моменты, на которые стоит обратить внимание:

  • Придерживайся единого стиля оформления.
  • Добавляй иллюстрации (схемы, диаграммы, скриншоты и т.д.) и графические компоненты – так документ лучше читается.
-3
  • Разбивай текст на разделы и абзацы:
    – 1 текст = 1 тема,
    – 1 раздел = 1 предмет описания,
    – 1 абзац = 1 мысль.

5. Показывай свои тексты техническим экспертам

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

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

6. Перечитывай текст целиком перед отправкой

Вообще вычитывай текст регулярно: после исправления большой партии замечаний или хотя бы после исправления всех замечаний.

"А если я ни разу не отправлял текст на проверку, а только создаю его?". Тогда перечитывай материал целиком свежим взглядом в начале каждого нового дня. Или хотя бы через день, если медленно продвигается.

-4

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

P.S.

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