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

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

• Авторы, которые обычно пишут менее формальный, объемный контент, например книги.
• Копирайтеры обычно пишут краткие тексты для рекламы, сообщений в социальных сетях, описаний продуктов и других средств массовой информации.
• Технические писатели, которые обычно пишут документацию по продукту и материалы справочного центра.
• Блоггеры обычно сосредотачиваются на контенте средней длины для веб-публикации.

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

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

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

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

Это то, чем занимается технический писатель, и именно так они заслужили должность технического писателя .

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

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

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

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

Как и следовало ожидать, все это подпадает под рубрику «техническая документация», следовательно, технические писатели. Само содержание, как и следовало ожидать, техническое.

Технические писатели могут быть:

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

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

Что конкретно делает технический писатель?

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

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

• Изучение технических спецификаций бизнес-отдела, процесса или продукта.
• Планируйте техническую документацию в логическом порядке.
• Поймите, что нужно, а что нет для целевой аудитории.
• Создавайте, копируйте и уточняйте документацию.
• При необходимости создайте диаграммы и другие иллюстрации.
• Поддерживайте соответствующий глоссарий, часто задаваемые вопросы или другую библиотеку соответствующей терминологии.
• Разрабатывайте технические отчеты или формализованные предложения для использования в бизнесе на высоком уровне.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

«Войдите в свою панель инструментов и найдите раздел «Отчеты» на боковой панели».

Для меня этого достаточно, потому что я не пишу техническую документацию; Я пишу довольно простую инструкцию. Между тем, технический писатель может написать:

«На панели инструментов щелкните заголовок «Отчеты» на левой боковой панели, третий сверху».

Они более конкретны, потому что часть технической документации — это специфика. Конечно, это общий пример.

4. Технические писатели также нуждаются в понимании логического потока. При документировании бизнес-процесса вашему писателю потребуются навыки критического мышления, и шаги должны быть правильно упорядочены. Рассмотрим, например, рецепт. Вы пишете пошаговые инструкции по выпечке буханки хлеба одну за другой в порядке их выполнения. Однако вы можете реорганизовать некоторые из них; например, нет смысла ставить «разогреть духовку» в начале, когда есть час на расстойку теста перед выпечкой; никто не захочет, чтобы их духовка так долго работала без ничего внутри.

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

5. Это связано с еще одним требованием для технических писателей, которое требует единого источника. Единый источник означает получение массива информации и создание нескольких частей контента, предназначенных для разных аудиторий. Автомобильный пример руководства пользователя и руководства Haynes — хороший пример; оба они содержат информацию об одном и том же автомобиле из одного и того же источника (производителя), но один гораздо более технический.

6. Некоторым техническим писателям также могут понадобиться базовые знания кода или веб-разработки. Например, техническому писателю, создающему документацию по обслуживанию клиентов, может потребоваться достаточное знание HTML, CSS, JavaScript или синтаксиса Wiki, чтобы начать веб-документацию с нуля или в рамках фреймворка. Технические писатели редко пишут чисто текстовые копии — обычно им требуется еще один навык, чтобы считаться техническим писателем.

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

Любой ли может быть техническим писателем?

Честно говоря, нет.

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

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

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

Многие авторы технического контента выбирают интересующую их отрасль и специализируются на ней.

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

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

Вам нужен технический писатель?

Может быть!

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

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

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

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

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

По данным Бюро статистики труда США, технические писатели зарабатывают в среднем около 75 000 долларов в год, а высококвалифицированные технические писатели зарабатывают более 100 000 долларов в год, и на это есть веские причины. Они на вес золота при правильных обстоятельствах.

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