Как стать техническим писателем?

Сокращенный перевод статьи «How to Become a Technical Writer».

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

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

Что такое техническое писательство?

Данный термин можно толковать по-разному. Grammar даёт наиболее точное определение:

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

Проще говоря, под этим понятием подразумевается однозначное, четкое объяснение или предоставление инструкций по конкретной теме.

Какие навыки нужны техническому писателю?

Люди, желающие стать техническими писателями, часто опасаются, что не смогут хорошо писать, потому что не имеют врожденного дара к этому делу. Отсюда вопрос: писателями рождаются или становятся?

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

Читать ответы было увлекательно. Большинство всё-таки убеждено, что писательство – врожденный дар. Интересно, что некоторые люди поддержали оба варианта, то есть, по их мнению, писателями и рождаются, и становятся. Странно, правда?

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

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

А теперь – к делу! Вот пять навыков, которые следует развивать, чтобы стать успешным техническим писателем.

Учитесь писать

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

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

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

Хотите усовершенствовать свою письменную речь? Следуйте этим правилам:

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

Познакомьтесь со своей аудиторией

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

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

Но как же «познакомиться» со своей аудиторией?

Спросите себя, кто ваши читатели

Задайте себе вопросы типа «Кто мои читатели и почему они читают мою статью? Что они ожидают от неё?»

Например, перед написанием этой статьи я пришла к следующим ответам:

• Кто они? Люди, которые хотят стать техническими писателями.
• Почему они это читают? Они хотят узнать о навыках, необходимых в данной профессии.
• Что они ожидают найти в моей статье? Всё, что нужно для начала карьеры технического писателя: скиллы, подсказки, советы и многое другое!

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

Используйте правильные термины

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

Дайте своей статье/документации подходящее название

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

Например, не следует называть статью «Глубокое погружение в React», если в ней пойдёт речь лишь о рендеринге элементов – вы рискуете разочаровать читателей, которые ожидали получить полную информацию о данной библиотеке.

Лучше придумайте более конкретное название, точно передающее содержание статьи – например, «Как рендерить элементы в React».

Совершенствуйте свои технические навыки

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

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

Закончу мысль знаменитой цитатой:

Если вы не можете объяснить что-то шестилетнему ребёнку, вы сами этого не понимаете.

Альберт Эйнштейн

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

Учитесь искать информацию

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

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

Как следует проводить исследования?

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

Разрабатывайте собственный стиль

Вы когда-нибудь задумывались, почему люди оставляют комментарии вроде «Благодаря вашей статье я наконец-то всё понял» или «Я прочитал кучу статей на эту тему, но только сейчас всё стало ясно, спасибо!»?

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

Что это значит? Это значит, что каждый уникален. Если два разработчика пишут на одну и ту же тему, вполне возможно, что кому-то из читателей будет более понятна первая статья, а кому-то – вторая. Почему? Подача материала у разных авторов будет восприниматься читателями по-разному.

И как же создать свой уникальный стиль?

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

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

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

Как стать техническим писателем

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

Секрет успеха в том, чтобы начать действовать.

Марк Твен

Начнём с цитаты Марка Твена – данный принцип следует припоминать каждый раз, когда принимаетесь за какую-либо задачу. Решить стать техническим писателем – это замечательно, но начать делать что-либо в данном направлении – ещё замечательнее.

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

Пройдите учебный курс

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

Я многому научилась на курсе по техническому писательству от Google, настоятельно советую и вам его пройти (как вариант — какой-нибудь аналогичный курс).

Читайте книги и технические статьи

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

Лиза Си

Чтение – неотъемлемая часть обучения: оно улучшит ваш словарный запас, поможет оставаться в курсе всех трендов, узнавать новости из мира писательства, а также держать себя в форме.

Для этого я очень рекомендую статьи с источников freeCodeCamp, Hashnode, The Writing Cooperative и т.д.

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

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

Джин Ауэл

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

Но с чего же начать?

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

Не стоит строить свой блог с нуля: это займёт кучу времени и отвлечёт вас от основной задачи – собственно написания статьи.  Свой блог я создала при помощи Hashnode: он очень быстр, располагает мощным сообществом и позволяет вам привязать блог к своему домену.

После того, как вы освоитесь, можете попробовать стать одним из авторов на каком-нибудь крупном портале, например, freeCodeCamp. Если ваша заявка будет одобрена, вы сможете публиковать статьи на этой платформе для широкой аудитории.

Не сворачивайте с выбранного пути

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

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

Октавия Батлер

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

Если вам сложно заставить себя постоянно писать, можете попробовать поучаствовать в челлендже #2Articles1Week Writing Challenge.

Помогайте open-source проектам

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

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

5 советов, которые помогут вам начать писать

Когда закончите первый черновик своей очередной статьи, вспомните несколько советов:

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

Заключение

Техническое писательство остаётся высоко востребованным направлением на рынке труда. Более того, ожидается рост спроса по крайней мере на 10% с 2014 по 2024.

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

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

Надеюсь, у вас получится не только встать на путь технического писательства, но и не свернуть с него: настойчивость поможет вам достичь вершин профессии.

От редакции Techrocks: если вас заинтересовала эта тема, рекомендуем статью «Технический писатель: обзор профессии».

[customscript]techrocks_custom_after_post_html[/customscript]

[customscript]techrocks_custom_script[/customscript]