День технического писателя: С Днем технического писателя! — Кошек, фильмов, книг и друзей много не бывает! — LiveJournal

чем занимается и как проходит типичный рабочий день

Александр Клименков

ведущий технический писатель Bercut

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

Бэкграунд

Меня зовут Александр Клименков, я — ведущий технический писатель, кандидат технических наук по специальности «Системный анализ, управление и обработка информации», закончил Санкт-Петербургский электротехнический университет («ЛЭТИ»). В компании Bercut работаю более 5 лет, очень люблю свою профессию. До прихода в Bercut работал преподавателем, техническим писателем и ведущим бизнес-аналитиком.

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

Как и большинство наших коллег в IT-сфере, сейчас мы работаем из дома. Переход на удалённый режим работы, конечно, внёс некоторые коррективы в нашу повседневную деятельность, но рабочие процессы от этого почти не поменялись. Мы всё так же пишем пользовательскую документацию, всё так же общаемся с коллегами в Teams и Skype, пользуемся теми же рабочими инструментами и серверами. Разве что звонки по местным телефонам мы заменили перепиской и созвонами в мессенджерах.

Биоритмы и конвенции

Режим рабочего дня, как и процессы, тоже не особо изменился. Ещё до перехода на удалённый режим в нашей компании каждый сотрудник мог выбирать время начала рабочего дня: кто-то приходил на работу в 8 утра, кто-то — в 11. Главное, чтобы все были на месте в определённый дневной период и работали положенные 8 часов. На удалёнке эти правила сохранились. Среди нас есть свои «совы» и «жаворонки» и каждый начинает рабочий день в удобное ему время. В любом случае проснуться можно попозже — ведь не нужно тратить время на утренние сборы и дорогу до работы.

Типичное рабочее утро писателя начинается с кружки крепкого кофе и обновления локальной копии из SVN. Нужно загрузить к себе изменения, которые другие писатели сделали за прошлый день. У читателя, не знакомого с нашей профессией, может сразу возникнуть вопрос: что же писатели хранят в SVN, ведь это не программисты, исходников у них нет. В том-то и дело, что есть. Об этом нужно рассказать подробнее.

Инструменты писателя

Мы пишем документацию в формате DITA. Это формат, основанный на XML, который позволяет сохранять исходный текст документов в структурированном виде. Мы пишем исходники документации в этом формате, для этого у нас есть редактор oXygen XML Author. Затем из этих исходников мы можем собрать итоговый документ в любом нужном формате. Для этого есть специальный Toolkit, содержащий XSLT-преобразования. Наш Toolkit позволяет собирать документы во множестве форматов. Самый востребованный — это PDF, иногда собираем CHM или HTML. При желании мы можем собрать даже EPUB, если заказчик вдруг захочет почитать нашу документацию перед сном на электронной книге. По необходимости мы вносим правки в XSLT-преобразования, чтобы изменить правила сборки документов и их внешний вид.

Подробнее о формате

Формат DITA вообще оказался очень удобным инструментом именно для разработки технической документации с её специфическим содержанием. Например, мы можем повторно использовать любой блок текста или целый раздел из одного документа в другом документе. И это будет не привычный «copy-paste», а именно использование одного блока в разных документах. Если в этом блоке что-то изменится, нам достаточно будет поменять текст один раз — изменение автоматически попадёт во все документы. Ещё мы можем применять фильтрацию — написать один универсальный раздел, вставить в несколько документов и потом фильтровать его содержимое в зависимости от типа документа, заказчика, системы и других параметров. А ещё мы не задумываемся о перекрёстных ссылках между разделами — достаточно в нужном месте указать ключ раздела, на который мы хотим сослаться. Toolkit при сборке документа сам пронумерует разделы и сделает красивые гиперссылки.

Погружение в процесс

Каждый писатель редактирует DITA-файлы у себя в локальной копии, а затем выгружает изменения в SVN. Часто бывает так, что над одним документом работает несколько писателей. Чтобы в этом случае не было конфликта правок, у нас есть специальный чат, где можно оповестить своих коллег о начале работы с определённой частью документа или об обновлении общих коллекций, например — глоссария. Может, это и не самое технологичное решение, но оно работает. Никому из писателей не хочется потом «мёржить» (merge) куски сложных технических текстов.

После обновления локальной копии SVN начинается работа. Мы работаем по задачам в Jira. У нас есть специальный тип задач с префиксом DOC. Обычно они связаны с задачами на разработку или с запросами заказчиков. Задачи на документирование создают менеджеры, которые ведут проект, тестировщики, сотрудники службы поддержки. Заказчик тоже может инициировать изменение документации, задав вопрос, высказав пожелание или жалобу. Team Lead нашей команды планирует деятельность каждого писателя, распределяет задачи, следит за их выполнением и отгрузкой документов.

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

Внутренняя «кухня» — источники вдохновения

Начиная работать над очередной задачей, писатель изучает многочисленные источники информации и преобразует полученные оттуда данные в пользовательскую документацию. Источников у нас много. Самый главный — это технический проект (ТП), которые пишут бизнес-аналитики ещё до начала разработки. ТП — это закон для разработчиков, тестировщиков и технических писателей. В идеале всё должно быть реализовано именно так, как написано в ТП. На деле же оказывается, что итоговая реализация отличается от ТП. Вы знаете, как это бывает: что-то не учли, что-то поняли неправильно, что-то оптимизировали… Для того, чтобы узнать, как на самом деле всё было реализовано, мы используем техническое описание (ТО), которое пишут разработчики. Там есть больше технических подробностей, описаны изменения конкретных типов данных и таблиц в БД, приведены алгоритмы работы процедур серверного кода, приведены скриншоты добавленных или изменённых окон в клиентских приложениях. Без ТО нам было бы очень трудно написать полноценную документацию. К сожалению, разработчики иногда откладывают написание ТО на самый последний момент.

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

ТП, ТО и описание настроек — это основные источники, из которых писатель получает информацию. Но есть ещё множество дополнительных: исходный код серверных процедур и клиентских приложений, XML-описания параметров, страницы в базе знаний Wiki, наконец — вопросы разработчикам и тестировщикам в мессенджерах. Ну и, конечно, сами системы — их web-интерфейс, клиентские и серверные приложения.

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

Один в поле не воин

Часто думают, что технический писатель — это профессия, не требующая особых коммуникативных навыков. На практике оказывается, что для написания документации каждый день приходится консультироваться со множеством коллег: бизнес-аналитиками, разработчиками, тестировщиками. Бывает так, что в исходных документах авторы что-то опускают, что-то недоговаривают. Работа писателя — быть профессиональным занудой: уточнять, переспрашивать, перепроверять информацию много раз, чтобы правильно всё описать и не допустить ошибку в документе. Бывают случаи, когда писатели находят ошибки в реализации. Писатель выполняет свою работу на самом последнем рубеже перед отгрузкой системы и документации заказчику.

На поверку становись!

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

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

Праздник труда

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

Клиент всегда прав — отгрузка до 23.59.59

После проверки мы отгружаем документы заказчику. Документы на систему мы отгружаем одновременно с передачей готовой системы. Новые версии ранее отгруженных документов мы, по сложившейся традиции, передаём в пятницу. Документацию мы пока отгружаем в формате PDF — вместе с новой версией системы заказчик получает пакет файлов. Их можно скачать на специальном портале, где каждому заказчику доступна документация по тем системам и их версиям, которые у него установлены. Кстати, нашей документацией пользуются не только заказчики: многие сотрудники компании Bercut тоже обращаются к нашим документам, чтобы разобраться в каком-то сложном вопросе по функционированию той или иной системы.

Большие надежды — портал bercut.web.docs

Конечно, PDF-файлы — это не самый удобный формат пользовательской документации. К примеру, поиск нужной информации можно выполнять только в рамках одного PDF-файла. Нельзя поискать описание какого-то параметра сразу во всей документации по системе. Это очень неудобно, ведь количество документов на одну систему часто исчисляется десятками. Если не знать, в каком документе искать нужные данные, то поиск превращается в нетривиальную задачу. Сейчас мы работаем над созданием портала, на который сможем выгрузить документацию в формате HTML. Там будет предусмотрен удобный полнотекстовой поиск по всем страницам или по части документации, например, по страницам на определенную версию определенной системы.

Да здравствует Команда!

Также по пятницам у нас обычно проходит еженедельное совещание нашей команды в Skype. Эта традиция появилась у нас с переходом на удалённый режим работы. На совещании наш Team Lead делится с нами свежими новостями компании Bercut, рассказывает о новых краткосрочных и долгосрочных задачах и планах. Писатели по очереди рассказывают о своих задачах и рабочих проблемах — что сделано за прошедшую неделю, что планируется сделать на следующей. Такое обсуждение помогает нам скоординировать свои действия, ведь часто над пакетом документов к очередной версии системы работает сразу несколько писателей.

Последний штрих

Заканчивается рабочий день технического писателя тем же, чем и начинался — синхронизацией с SVN. Конечно, мы часто выполняем промежуточные синхронизации и в середине дня, но вечером обязательно проверяем, все ли изменения выгружены на сервер. Будет обидно, если вся работа, сделанная за день, пропадет даром. И конечно, надо не забыть оформить трудозатраты — вписать в задачи Jira время, которые мы на них потратили за этот день.

Призвание

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

Один день технического писателя: odin_moy_den — LiveJournal

Здравствуйте! С вами опять Татьяна, переводчик и технический писатель из Торонто. Мои предыдущие посты в сообществе можно увидеть здесь. Сегодня вы проживете со мной 6 августа 2014 года. В прошлом посте я рассказывала о своей работе переводчика, а сегодня постараюсь осветить другую сторону своей деятельности — техническое писательство. Помимо работы, я за этот день была в спортзале, покупала печенье, ела суши и побывала в гостях. Кроме того, в посте будет много котиков (точнее, только два, кот и кошка, но они ведут себя так, как будто их очень много) и одна собака.
Поехали!

1. Просыпаюсь в несусветную рань. (Кажется, это стало традиционным зачином моих «дней». Честное слово, обычно я встаю в 12 часов дня или даже позже.)

2. А вот и причина столь раннего подъема — это письмо из домоуправления, в котором говорится, что сегодня  у нас будут мыть пол в гараже, поэтому машину надо оттуда убрать к 8 часам утра. Пол моют аппаратом, нагнетающим воду под давлением. Я специально налепила письмо на внутреннюю сторону входной двери в квартиру, чтобы про него не забыть.

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

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

5. 7:55. Еду в лифте вниз, в гараж.

6. Забираю машину. Наклейка на бампере — память о фотосафари в Танзанию, куда я ездила несколько лет назад.

7. Я уже прикидывала, куда бы на окрестных улицах можно было бы поставить машину, но мне колоссально повезло — место нашлось прямо у тротуара возле дома. Последнее.

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

9. Это мои планы на первую часть сегодняшнего дня. Как всегда, они будут корректироваться по ходу дела. Записи в календаре я делаю то по-русски, то по-английски — видимо, в зависимости от того, на каком языке в это время думаю.

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

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

12. Убедившись, что им ничего не светит, они мрачно удаляются в гостиную, а я ложусь досыпать.

13. 9:30. Просыпаюсь второй раз за утро. Вспоминаю, что не записалась на утреннее занятие кроссфитом, на которое собираюсь. Иду на сайт и записываюсь. Сейчас лето и зал все равно будет полупустой, но мало ли.

14. Выхожу в гостиную. Кошка взирает на меня с мрачным пессимизмом: «Шляются тут всякие… А покормить не покормят… Нет, от этих двуногих ничего хорошего не дождешься…» Коту же все по барабану — он безмятежно взирает на потолок.

15. Кофе.

16. Время 10:38. Я уже в зале. Опоздала на 8 минут. Как ни странно, тренер сегодня добрый и не заставляет меня делать 50 «лягушек».

17. Вот так я пока не умею.

18. Время 11:40. Занятие кончилось. Надо перекусить — отсюда я еду прямо к клиенту, без захода домой. Можно пристроиться в хвост очереди за серой машиной и заказать еду не выходя из-за руля, но очередь машин кажется мне слишком большой. Паркуюсь и захожу внутрь кафе.

19. Здесь тоже очередь. На табло справа предлагают «сэндвич для завтрака на кленовом бисквите». Это не бисквит в нашем понимании, а то, что в Британии называется scone. Не зря Бернард Шоу говорил, что Англия и Америка — две страны, разделенные общим языком. Словом bisсuit в британском английском обозначают печенье — то, что в американском английском называется cookie. Русский же «бисквит» по-английски будет sponge cake. Никакого порядка.

20. Чтобы не соблазняться плюшками в витрине, начинаю читать Агату Кристи.

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

22. Аудиокнига — я по-прежнему слушаю «Щегла» Донны Тартт.

23. Еду. Скоростное шоссе проходит по берегу озера. В просвете между домами  виден даунтаун Торонто с башней CN Tower. Она была самым высоким отдельно стоящим строением в мире, пока в Дубае не построили очередной небоскреб.

24. Смешная реклама на щитах. «В 4 километрах впереди замечены акулы» — это рекламируют недавно открывшийся в Торонто аквариум. На соседнем щите написано: «А наш аквариум имеет 6 000 километров в длину. Приезжайте в провинцию Новая Шотландия», и показан торчащий из воды китовый хвост. Это намек на то, что там можно наблюдать китов прямо в естественной среде их обитания, то есть в океане.

25. 12:35. Я уже у офиса клиента. Расскажу, чем я буду сегодня заниматься. Канадское правительство возмещает компаниям часть расходов на разработку технических новаций (я знаю, что в современном русском языке используется слово «инновация», но очень его не люблю; это тупая калька с английского innovation, при том что слова «новация», «новатор» в русском языке появились лет сто назад. То же относится к «лобстерам», «ритейлерам» и прочим «вызовам» с «активностями». Просто некоторые люди страдают терминальной мозговой ленью и имеют чрезвычайно ограниченный словарный запас а ля Эллочка-людоедка, в который такие слова, как «омар»  и «розничная торговля» просто не вошли.) Так вот, канадское правительство проводит программу налоговых кредитов, по которой компаниям возмещается часть расходов на научные исследования и экспериментальные разработки. Моя задача — поговорить с клиентом и написать убедительный отчет, чтобы чиновник в налоговой службе прослезился от гордости за отечественную хайтек-индустрию и дал денег. Как правило, мне это удается 🙂 Иногда, впрочем, чиновник упирается и заявляет, что это никакое не новшество. Тогда приходится защищать заявку, для чего пишется и собирается тонна подтверждающих документов. В моей практике, примерно в 50% случаев отказа заявку таки удается отстоять. В других 50% случаев чиновник попадается особо упертый или просто предубежденный — ну, значит, не повезло, но, к счастью, таких не очень много.
Кроме написания заявок на налоговые кредиты, я занимаюсь еще созданием технической документации на программное обеспечение, но этот процесс уже совсем не зрелищный, так что про него я пока делать «день» не собираюсь.

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

27. Время 13:05. Я уже у клиента. Он показывает мне, как работает их система. (Кадр размыт намеренно, для защиты конфиденциальных данных.) В открытое окно умопомрачительно пахнет печеньем — здесь за углом кондитерская фабрика.

28. В 14:30 встреча закончена. Я несусь в магазин при фабрике, чтобы накупить печенья ПОБОЛЬШЕ, ПОБОЛЬШЕ!!! Магазин рядом, от офиса клиента метров двести и завернуть за угол.

29. Это с кленовым сиропом, но я его не люблю.

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

31. Надо пообедать. Вечером я собираюсь в гости к приятелю, который живет в Ричмонд-хилле, это на север. Решаю, что ехать туда лучше сейчас, пока не начались вечерние пробки, а там сесть и поработать в каком-нибудь кафе. Думаю, чего мне хочется на обед, и решаю, что суш. Нахожу «сушильню» в Ричмонд-хилле. Гугл-карта в телефоне сообщает, что ехать туда чуть больше получаса и что пробка по дороге есть, но небольшая.

32. Еду. Дорога относительно свободна — никакого сравнения с той давкой, которая тут начнется через час или около того.

33. Время 15:30. Приезжаю в «сушильню». Она оригинально оформлена — у входа стоит костюм самурая, туалет в том же стиле, и даже в закутке, где находится мой столик, красуются на подставке два самурайских меча.

34. Приносят еду.

35. Ем и одновременно читаю с телефона статьи в интернете и почту — собираю информацию для путешествия в Европу, которое я планирую на середину октября. Кстати, оказалось, что турагентша ошибается и на Мальте в это время прекрасно можно купаться.

36. 17:00. Суши съедены. Перебазируюсь в расположенное по соседству Кафе Всемирно Известной Сети с Очень Вредной Едой, где есть вайфай и можно поработать. Перевожу на английский три статьи для журнала и отправляю редактору, носителю языка, на проверку. Одновременно сообщаю приятелю, к которому вечером собираюсь в гости, что сижу в кафе недалеко от него и могу приехать в любой момент. (Приятель в это время едет домой с работы.)

37. После этого залезаю в ЖЖ, одновременно поглядывая одним глазом на экран телевизора с новостями (все равно ничего хорошего не скажут).
Наконец в 19:30 приятель сообщает по скайпу, что он уже дома.

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

39. Сворачиваю внутрь квартала. Вот такой мягкий вечерний свет.

40. На столбе — индикатор скорости проезжающей машины. Питается от солнечной батареи (панель прямо на столбе над индикатором). Вообще здесь ограничение 50 км, но у меня не получилось одновременно вести машину, не сбрасывая скорость, и целиться объективом в приборчик на столбе. Мимо бежит бегом от инфаркта какая-то дама, видимо местная жительница.

41. Подъезжаю к нужному дому.

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

43. «Сидеть!»

44. Выходим на задний двор. Справа под чехлом барбекюшница.

45. Запасаемся поп-корном (точнее, чипсами и фисташками). Комплект подставок с надписью «Тролль» я привезла приятелю в подарок из Норвегии. Это такой ехидный намек на некоторые его сетевые привычки. Кстати, в русском языке уже появился какой-нибудь аналог английского placemat? Оно мне как-то попалось в переводе художественной литературы, я долго мучилась и в итоге обозвала его «сервировочным ковриком».

46. Смотрим сериал о приключениях развеселой дамочки Фрины Фишер.

47. Собака Баскервилей. Сидит на решетке центрального кондиционирования — там приятная прохлада.

48. 22:20. Делаем перерыв.

49. 22:30. Смотрим дальше. Фрина совещается со своим любовником, он же по совместительству инспектор полиции, над очередным свежеубитым трупом.

50. Время 23:25. Собака просится гулять. Идем на улицу.

51. Около полуночи возвращаемся, и я сажусь в машину.

52. Опять «Щегол». До дому ехать примерно 45 минут.

53. Ну я все понимаю, в Торонто бывают пробки, но не в час ночи же!

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

55. Ставлю машину в гараж. Пол действительно помыли, не обманули.

56. Жывотное, увидев меня, тут же бежит к пустой миске.

57. Ненадолго лезу в интернет.

58. Файлы вернулись от редактора. Надо их просмотреть, принять (или отвергнуть) изменения и отослать клиенту. У меня, как у всех не-носителей английского, проблема с артиклями. Но хорошо, что только с ними. Пять-шесть артиклей на страницу это не так плохо.

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

60. От такой работы мне положено молоко за вредность. И шоколадка.

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

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

63. В сообществе «что читать» просят порекомендовать литературу по очень важному вопросу.

64. Это напоминает мне, что я собиралась варить гороховый суп. Иду на кухню. Выкладываю ингредиенты на стол. Слева лежит кость от окорока — на ней почти не осталось мяса, но она придаст супу наваристость и вкусный копченый аромат.

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

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

67. «А я вот так умею! И еще вот так! И еще хвостом так!»

68. «Ну правда же я няшечка?! Ну почеши мне пузо и дай пожрать уже!»

69. В награду за старания кота пытаюсь запечатлеть его на селфи. Коту почему-то не нравится эта идея, и он активно вырывается.

70. А время-то уже три часа ночи! Пора спать. Спасибо, что провели этот день со мной!

Профессия — технический писатель: гуманитарий и технарь в одном лице

Этот материал прежде всего заинтересует тех, кто хочет освоить новую и ещё не слишком известную в Беларуси ИТ-профессию — технический писатель. В канун професионального праздника «техрайтеров», который отмечается 17 декабря*, мы встретились с командой Softeq Flash Solutions по подготовке технической документации и попросили их рассказать о своей работе. О том, чем занимаются технические писатели, какие книги нужно прочитать начинающим и почему коммуникации и индивидуальный подход решают в этой профессии всё, — в нашем интервью.

Читать далее

Вероника Каптур и коллеги

— Расскажите, как вы пришли в профессию?

Дина Волкова: Я работаю техническим писателем уже семь лет. Всё это время я специализируюсь в области разработки устройств памяти.

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

Татьяна Богдевич: Я в профессии — чуть больше года, до этого преподавала английский язык в школе и на курсах иностранных языков, был опыт удалённой работы техническим писателем, переводчиком и копирайтером, но область ИТ была мне всегда интересна.

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

Дина: Действительно, специфика нашей работы в том, что мы пишем для инженеров. То есть, информация через нас передаётся от разработчика к разработчику.

Татьяна: А это требует от нас более глубокого понимания того, как работает то или иное приложение. Более того, нам приходится разбираться не только в software-приложениях, но и в firmware, то есть понимать, как работает железо.

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

Дина: Поскольку мы не имеем такого же багажа технических знаний, как разработчики, нам часто приходится не только задавать вопросы, связанные со спецификой проекта или разрабатываемого модуля, но также выяснять некоторые вещи, которые программистам кажутся очевидными. При этом мы не имеем права постесняться и не спросить, так как это влияет на точность понимания нами того или иного предмета. И поначалу, если у вас немного опыта работы в ИТ, может возникуть определённый психологический барьер.

Дина Волкова

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

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

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

— Что должен изучить технический писатель, чтобы быть успешным?

Вероника: Мне помогло то, что я читала очень много дополнительной литературы. Кстати, на русском языке её почти нет. Также базовое представление о специфике работы в ИТ я получила на курсах тестировщика.

Татьяна: Прежде всего, слово писатель предполагает хорошее владение языком или языками, на которых создаются документы (в нашей компании это прежде всего английский). И, конечно же, необходимы заинтересованность и базовые знания в области ИТ, поэтому я прошла курсы тестировщика и получила начальные знания по программированию на курсах по PHP. Само собой разумеется, как и в любой области, важное значение имеет непрерывное самообразование: изучение специализированной литературы (желательно аутентичной — на английском языке), общение со специалистами в данной области, и даже просто чтение «чужих» документов.

Дина: Конечно же, необходимо читать профессиональную литературу: книги, блоги, статьи. Для получения дополнительных знаний в сфере ИТ я бы порекомендовала прослушать курсы по основам программирования, тестированию. Для меня одними из самых полезных были курсы «Introduction to Computer Science and Programming Using Python»: 

Татьяна Богдевич

— То есть можно сказать, что технический писатель — это гуманитарий и технарь в одном лице?

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

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

— Вероника, знаю, что ты была «техрайтером» в игровых проектах. Есть ли разница?

Вероника: Разительных отличий нет. Просто приходилось делать разные типы документов. В целом, всё то же самое: интервьюирование, составление текстов, их оформление. Разница только в атмосфере. В игровых командах цена ошибки ниже и рабочая атмосфера более непринуждённая, подстёгивающая креативность. Программисты же Softeq Flash Solutions — это зрелые специалисты, которые погружены в работу настолько серьёзно, что времени на большое веселье у них нет.

— Давайте перейдём к рекомендациям тем, кто мечтает о профессии технического писателя. Насколько для этого важно образование?

Татьяна: Образование здесь не играет ключевой роли. Важно желание быть «техрайтером»: если написание инструкций, руководств пользователей приносит удовольствие — возможно, это как раз то, что вы ищете. И, конечно же, без знаний языка и интереса к предметной области здесь не обойтись. Например, техническому писателю в компании, разрабатывающей медицинскую аппаратуру, должно быть интересно разобраться в работе этой аппаратуры. Соответственно, в ИТ-области необходим интерес именно к тому узкому направлению индустрии, в котором работает компания.

— Какие книги было бы полезно прочитать и освоить будущиму техническому писателю?

Вероника: Я рекомендую:

— А какими программными продуктами должен владеть каждый технический писатель?

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

• MS Office (Word, PowerPoint)
• Atlassian Confluence
• Visio
• SnagIt
• Camtasia Studio

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

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

Дина: Коммуникабельность, доброжелательность, умение работать в команде, желание учиться.

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

Вероника: Ну, и любовь к тому, что ты делаешь. Без неё и здесь никуда.

*Официального праздника у технических писателей нет. Мы выбрали этот день четыре года назад, так как 17 декабря 1998 года была принята резолюция Совета Европы, в которой говорится о необходимости профессии технический писатель «для обеспечения потребителям доступа к адекватной эксплуатационной документации, гарантирующей корректное и полноценное использование продукта». Возможно, нам удастся сделать этот день официальным Днём технического писателя в Беларуси.

Один день из жизни технического писателя

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

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

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

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

Ровно в 9.00 начинается stand-up митинг,
в компании мы его называем по-свойски «Летучка».

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

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

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

Теперь я создаю документ, в котором буду разрабатывать описание программы.

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

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

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

Вам сложно понять, что нужно писать, с чего начинать, как
писать? Не переживайте.

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

Запускаю программу и поочередно описываю
каждую ее вкладку: «Основное окно», «Настройки». Обязательно добавляю
назначение программы и общие разделы, например, «Способы запуска». Структуру
текста я как раз беру из готового формата описания.

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

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

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

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

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

Во второй половине дня мне пришла задачка по сборке
руководства пользователя в формат PDF. Сложно? Совсем нет. Открываю руководство в программе Help&Manual, умеющей собирать тексты в нужный
мне формат, выполняю несколько настроек по инструкции и нажимаю на кнопку
«Опубликовать».

Готово! Все элементарно и просто. Доработали оформление, а
там уже и вечер подступил.

На этом мой рабочий день закончился. А завтра мне
предстоит снимать видеоролики! Да-да,
справка может быть не только текстовой и статичной, но и интерактивной.

P.S. Надеюсь,
теперь вы отчасти представляете себе, кто такой технический писатель.
А вы бы хотели им быть? Решайтесь и пробуйте!

Один день из жизни технического писателя. Среда. | Станислав Андронов

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

Но достаточно мало кто понимает, кто такие технические писатели, и чем они занимаются. Очень часто нас путают с просто писателями, но это не так.

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

Ниже один обычный день совсем обычного техписа в Москве.

?Ну что, поехали!

7.24

Я проснулся, потянулся. Жена уже собирается в ванной. Посмотрел за окно – темновато и, наверное, зябко, поежился, но делать нечего, надо вставать и собираться.

Жена как раз пошла поднимать ребенка.

8.10

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

Дохожу за 5 минут до остановки. Холодный ветер делает пребывание на улице некомфортным, хочу или домой, или на работу.

Наконец, подъехал транспорт, и я еду к метро.

8.35

В метро. Тут сухо, тепло, много народу и кашля.

Пока еду, читаю книгу.

9.10

Наконец, я у работы. Внутри ждет вкусный завтрак и работа.

Наконец, я у работы. Внутри ждет вкусный завтрак и работа.

Сразу иду в столовую, чтобы не терять время.

Сразу иду в столовую, чтобы не терять время.

Манная каша, пудинг и черный чай с молоком. Нямка.

9.30

Я у своего рабочего места.

Рядом со мной живая пальма, а еще беспроводные наушники Sony, два ноутбука (нет, мака, увы, нет), один 24” монитор, мышка и клавиатура. Вот такой стандартный набор.

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

Пишу в markdown с помощью Visual Studio Code, далее подкладываю файлы в hugo, тем самым генерируя статичный сайтик с документацией, и всё это заливаю сверху гитом. В планах еще автоматизировать отправку md-файлов напрямую в Confluence.

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

В планах разобрать по косточкам neutron и, если успею, – glance. Приходится аккумулировать просто тонну информации и прогонять её через фильтр нашего продукта.

10.47. Сделал высокоуровневую диаграмму по службам neutron и дал им краткое описание. Далее планирую углубиться в эту тему.

Пока сделать перерыв и пойти выпить кофе. С кофе главное правило – не увлекаться. Наливаю кофе и иду к обратно.

12.10

Пора идти на обед. Это мой первый обед, стараюсь делить прием пищи на два раза, так полезнее.

Моя первая порция: булочка и куриная лапша. Очень вкусно.

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

Хочу помощи зала. Пишу, рисую, разбираю рулбуки.

14.30. Второй великий обеденный поход.

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

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

15.20

Стендап. Командой обсуждаем наработки. На всё про всё минут 15, продуктивно и не затратно.

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

17.40

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

Увы, план не выполнил, на glance нет уже сил, слишком объемный материал выходит по neutron, придется даже завтра с ним разбираться.

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

19.55

Пора собираться домой.

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

20.15

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

В метро хочу снова перечитать книгу “Пиши, сокращай”, но тут выяснилось, что в телефоне её нет, почему – загадка. Ну и ладно, глаза будут целее.

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

Но только не ГОСТ!

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

Технический писатель: роскошь или …?

Технический писатель: роскошь или …?

2001 год

До выхода на подруб или подпил должен быть оставлен
недопил, производить сквозной пропил дерева
без недопила запрещается.
Из инструкции по технике безопасности

Лифтер может допускаться к работе
только по назначению и в пределах
его номинальной грузоподъемности.
Из инструкции

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

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

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

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

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

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

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

Крупные производители программного обеспечения видят решение этой проблемы
в привлечении специализированных фирм, занимающихся исключительно разработкой
и написанием технической документации. И услуги таких фирм ценятся, как
правило, высоко. Что же делать тем компаниям, в чьи планы не входят крупные
капиталовложения в проекты?
В компании «1-й Архитектор бизнеса» решили, что производство коробочных
программных продуктов с дальнейшим их тиражированием не может быть успешным
без специальной рабочей группы, включающей технического писателя. При
этом он логично совмещает написание технической документации с итоговым
тестированием программы для подтверждения всех заявленных функций ПО и
контролем эргономичности интерфейса. Вместе с этими задачами технический
писатель занят изучением предметной области, проблемы которой решает программа.
Все это позволяет значительно повысить и полезность сотрудника, и его
квалифицированность.

Группа по выпуску типовых решений работает почти год. Главный итог ее
работы — двухсот страничное руководство пользователя к программе «АБ:
Строительные материалы 7.7.» Весьма специфическая функциональность
конфигурации потребовала скрупулезной работы группы и по отладке программы,
и по его описанию. Это было серьезное испытание, которое судя по всему
пройдено успешно: конфигурация «АБ: Строительные материалы 7.7» протестирована
в фирме «1С» и получила сертификат Совместимо! Система программ
1С: Предприятие. Сейчас в работе находятся еще 3 конфигурации.

Учитывая сложность проблемы и отсутствие какой-либо систематизированной
информации по методологии создания технической документации для ПО, трудно
переоценить важность редких попыток, направленных на развитие профессии
технического писателя.
Семинары для технических писателей компании Philosoft
скоро будут называть традиционными. Кроме собственно выступлений
и докладов, подготовленных сотрудниками фирм с опытом создания технической
документации, семинары ценны непосредственным общением специалистов, что,
несомненно, положительно сказывается на развитии технического писательства
в России. Тезисы докладов всегда можно найти на сайте компании Philosoft,
а вот для обмена мнениями полезно присутствовать на семинарах вживую,
тем более что для представителей компьютерных компаний вход бесплатный.
На последнем семинаре 22 июня был представлен ряд докладов, подготовленных
сотрудниками компаний «1С-Рарус», «ОАО ТАНТК им. Г. М. Бериева» и компании
«ПРОМТ». Обсуждались возможности применения программы Adobe FrameMaker
6.0 в работе технического писателя. Использование этого программного
пакета в России стало возможным после его адаптации к кириллическим шрифтам.
Тут же были отмечены его преимущества:
— мощные средства автоматизации вёрстки;
— возможность содержания большого руководства в группе файлов, составляющих
единую книгу;
— единообразие оформления посредством шаблонов, описывающих практически
все аспекты оформления руководства — формат страниц, содержимое колонтитулов,
представление таблиц, уравнивания, методы нумерации;
— поддержка перекрёстных ссылок, исключающих дублирование материала руководства;
— автоматическое формирование оглавлений, указателя терминов, списка иллюстраций
и подобного справочного материала.

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

Вниманию слушателей были представлены возможности использования программы
Adobe FrameMaker с SGML для подготовки технических публикаций,
а в заключение семинара состоялась презентация новой программы PROMT
TerM — специализированного средства для автоматического извлечения
и обработки терминологии.

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

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

создание технической документации в Екатеринбурге

День 1

1.      Введение в курс

1.1.   Цели и задачи

1.2.   Понятие продукта и жизненного цикла

1.3.   Понятие заинтересованных сторон, потребностей и требований

1.4.   Техническая документация как инструмент согласования, верификации и валидации требований

1.5.   Место технической документации в жизненном цикле продукта

2.      Существующие стандарты написания технических текстов

2.1.   ГОСТ 3.1105-2011 Единая система технологической документации (ЕСТД)

2.2.   ГОСТ на разработку ТЗ 15.016-2016, 34.602-89, 19.201-78

2.3.   Стандарты ISO на разработку технической документации

Практическое занятие: разработка перечня требований

День 2

1.      Инструменты разработки технической документации

1.1.   Как структурировать документы?

1.2.   Метод описания сценариев использования.

2.      Практическое занятие: разработка сценариев

3.      Как сделать технические документы читаемыми?

3.1.   Инструменты MS Word для форматирования текстов

3.2.   Что включать в состав документов и что не включать

4.      Использование технической документации для управления

4.1.   Роль технических документов в принятии решений

4.2.   Важность создания единой системы технологической документации

4.3.   Роль технических документов в обеспечении качества

Практическое занятие: разработка и форматирование ТЗ в MS Word

International Technical Writing Day

Автор

Анастасия в Technical Communication on 8/14/2018 3 мин чтения

Сегодня особенный день для всех технических писателей! Команда ClickHelp поздравляет вас с профессиональным успехом, так как сегодня ваш праздник — День технического письма.
Ждать. Что значит такого нет ?!

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

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

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

Давайте выберем дату нашего праздника!

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

• 7 августа — во-первых, мы поняли, что современный технический текст тесно связан с компьютерами (да!), Поэтому день, когда Ховард Хэтэуэй Айкен и четыре других инженера разработал первый персональный компьютер в 1944 году, кажется, идеальное совпадение.
• 23 января (23 день года) — современный английский алфавит основан на классическом латинском, состоящем из 23 букв.Поскольку буквы являются литературным «письменным материалом», это было бы хорошим способом отметить письмо. Почему латынь? Что ж, это один из самых важных алфавитов в истории человечества, и многие языки произошли от него.
• 15 апреля — день рождения Леонардо да Винчи. Какое у него отношение к написанию технической документации? Итак, был изобретен механический печатный станок, началась Эра Разума, и эти факторы привели к необходимости начать документировать материал. И Леонардо да Винчи был одним из самых известных технических писателей своего времени! Он документировал все свои изобретения, и его «руководства пользователя» не теряли популярности с тех пор 🙂
• 27 апреля — день, когда первая пишущая машинка была запатентована Францем Ксавьером Вагнером.Это изобретение позже привело к появлению современных клавиатур — одного из основных инструментов технических писателей.
• 6 июля — термин «промышленная революция» впервые упоминается в письменной форме в письме французского посланника Луи-Гийома Отто. Промышленная революция ознаменовала начало современной эры технического письма.

Заключение

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

Удачи в написании технической документации!
Команда ClickHelp
Создавайте, размещайте и доставляйте документацию на разных платформах и устройствах

Хотите стать более профессиональным?

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

дней из жизни технического писателя | Кеси Паркер | Техническое письмо — это просто

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

• Получить задание .
• Поэкспериментируйте с продуктом. На этом этапе собирают информацию о продукте, играя с ним, интервьюируют людей, которые также работают над этим проектом, читают информацию о продукте и т. Д.
• Проведите собеседование с представителями малого и среднего бизнеса, чтобы узнать, как это работает. Способность эффективно работать с малыми и средними предприятиями имеет огромное значение для написания технических текстов.Многие вещи, такие как глубина, ясность и точность описаний в руководствах пользователя, зависят от того, насколько хорошо вы передаете свои запросы малому и среднему бизнесу и насколько успешно вы интерпретируете и отвечаете на вопросы. Прочтите следующую статью, чтобы узнать больше об интервьюировании МСП — Как провести интервью с МСП.
• Исследование аудитории. Поскольку технические писатели создают контент для людей, они должны изучать свою целевую аудиторию. Например, технические писатели могут собрать фокус-группу, чтобы задать пользователям несколько вопросов.Вот статья под названием «Как проводить интервью с пользователями», которая поможет вам правильно проводить интервью с пользователями.
• Начать писать документацию.
• Проведите дополнительное исследование и / или запланируйте дополнительные встречи с МСП.
• Напишите еще.

• Форматирование. Вам необходимо хорошо структурировать свой контент, чтобы сделать его более эффективным. Это не должна быть стена из текста, темы должны иметь заголовки, оглавление, указатель, перекрестные ссылки, ссылки и т. Д., Чтобы сделать вашу документацию более читаемой и простой в использовании.Вот статья о том, как я организовываю свою техническую документацию: Как я организую документацию.
• Периодически отправляйте части документа на доработку. Обычно рецензенты проверяют контент, но если в вашей команде нет рецензентов, спросите других членов команды или своих друзей.
• Опубликовать документацию. Документация может быть в Интернете или распечатана, но она должна быть доставлена ​​в форме, удобной для ваших читателей, и они быстро получат информацию.
• При необходимости обновите документ. Да, верно. Когда документация закончена, вы не можете вздохнуть с облегчением. Люди могут неправильно понять, что вы имели в виду, они обязательно зададут вопросы. Вот почему технические писатели всегда отслеживают внутреннюю статистику, сотрудничают со службой поддержки, чтобы узнать, как улучшить документацию и сделать ее более удобной для пользователей.

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

Технический писатель: Обычный день

Джейн МакСрибблз все еще не привыкла к мысли о том, чтобы иметь свой собственный стол в ее собственном кабинете. Она работала техническим писателем в Really Smart Software в течение трех месяцев, и единственное, что выделяет ее рабочее пространство как ее, — это справочники по написанию технических документов, ее потрепанная копия The Elements of Style и некоторые официальные документы о масле и газовая промышленность.

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

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

Встреча в 9:00 — это пережиток тех дней, когда RSS был ничем иным, как маленьким стартапом с пятнадцатью сотрудниками. Однако за последний год компания росла не по дням, а по часам, и у Джейн есть несколько предложений, как сделать утреннюю встречу более эффективной (или полностью отказаться от нее), которые она хотела бы обсудить, как только она окрепнет в своей новой жизни. роль.

Генеральный директор входит в конференц-зал ровно в 9:00. Он кратко излагает свои задачи на день. Затем по очереди все в комнате. Затем трое парней, работающих удаленно из таких мест, как Индиана, Чикаго и Нью-Йорк, занимают свои места. Встреча прерывается, и Джейн снова оказывается за столом, готовая приступить к работе.

Really Smart Software в настоящее время имеет одного клиента: компанию, которая владеет и управляет одним из крупнейших газопроводов в стране.Почти десять лет назад RSS написал программное обеспечение, которое теперь управляет всеми коммерческими операциями трубопровода.

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

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

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

Как только этот документ будет готов, он будет отправлен на рассмотрение в сервисную группу конвейера. Команда вернется к Джейн либо с «ОК», либо со списком вопросов и / или исправлений — по всей вероятности, ей придется пересматривать документ несколько раз. У Джейн также есть пара диаграмм, которые ей нужно создать для документа, хотя это не должно быть слишком сложно.

Джейн печатает до 11:30, затем берет свой ноутбук, блокнот и карандаш и направляется в конференц-зал на обеденную встречу с тремя старшими разработчиками RSS. Разработчики потратили полтора часа на изучение подробной информации, которая понадобится Джейн для двух документов, которые она будет готовить в следующий раз.

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

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

В 17:30 Джейн перестает писать, ее мозг истощен. Следующие тридцать минут она проводит, собирая вещи на завтра.Ей очень нравится работа с RSS: ей нравится ее график с девяти до шести, ей нравится узнавать о коммерческом программном обеспечении конвейера, и ей, , действительно нравится, , что она впереди в создании документации для группы обслуживания конвейера.

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

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

Один день из жизни технического писателя

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

Q1. Какая у вас должность?

Технический писатель

Q2. Чем занимается компания, в которой вы работаете?

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

Q3. Какое у тебя прошлое? (квалификация и опыт работы)

Бакалавр английской литературы и театра
Монтаж в детском издательстве
8 лет на руководящих должностях в компании по производству медицинского оборудования.
5 лет в области редактирования упаковки и маркировки медицинских изделий.
2 года внештатный редактор / написание: автобиографии; содержание веб-страницы; пресс-релизы; публиковал в Интернете статьи с советами и мнениями.
2 года репетиторства по английской литературе, возраст 7-16
Качественное структурирование и написание документов.

Q4. Что включает в себя ваша работа?

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

Q5. Каков обычный день в вашей роли?

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

Q6. Как вы попали на свою нынешнюю должность? (Вам нужна была определенная квалификация или опыт?)

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

Q7. Что вам больше всего нравится в вашей работе?

Разрушение плохо структурированных документов и их улучшение.

Q8.Что самое сложное в твоей работе?

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

Q9. Почему вы решили продолжить эту карьеру?

Я люблю слова.

Q10. К чему может привести такая работа?

Создание контента для крупных проектов, ролей управления контентом, функциональных ведущих ролей.

Q11.Какой совет вы бы дали тем, кто рассматривает эту роль как карьеру?

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

Q12. Расскажите, пожалуйста, что-нибудь еще, что вы хотели бы добавить о своей работе…

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

Больше интервью читайте здесь.

Здесь вы найдете самые свежие советы по работе и карьере.

Как стать техническим писателем: руководство для начинающих

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

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

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

Что такое технический текст

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

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

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

Определение стиля

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

роль

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

Преимущества

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

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

Растущий спрос

По данным Бюро статистики труда США, прогнозируется, что спрос на технических писателей вырастет на 10% с 2014 по 2024 год. Рост занятости в этой области превысит средний показатель по стране для других профессий из-за продолжающегося роста научно-технической продукции. .

Выдающиеся области технического письма

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

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

Процесс технического написания

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

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

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

1. Подготовка проекта

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

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

2. Анализ аудитории

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

Аудитория всегда находится в авангарде ума технического писателя.Читатель определяет текст. Как правило, техническая информация не меняется. Единственное, что меняется, — это то, как эти факты передаются. Хороший технический писатель корректирует текст в зависимости от контекста читателя.

3. Понимание пользователя

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

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

Например, если вы пишете финансовое предложение для пилотной программы НИОКР по удаленному управлению отоплением дома со смартфона, вашей аудиторией может быть руководитель, определяющий бюджет компании на следующий год.Чтобы правильно подготовить техническое предложение, вам необходимо знать знания руководителя в области исследования. Кроме того, было бы полезно знать его или ее основные финансовые проблемы, бизнес-факторы, которые обычно используются при принятии решений, и сроки.

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

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

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

• Кто они?
• Что им нужно?
• Где они будут читать?
• Когда они будут читать?
• Почему они будут читать?
• Как они будут читать?

Только после того, как вы ответите на эти вопросы, вы сможете приступить к подготовке документа.

4.Пользовательский опыт

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

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

По мере подготовки постоянно отступайте и просматривайте документ как читатель.Спросите себя: доступно ли это? Как бы они это использовали? Когда они будут его использовать? Легко ли ориентироваться?

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

Планирование вашего документа

Четко определив запрос документа и аудиторию, вы можете концептуализировать свой документ.

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

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

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

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

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

Консультации со специалистами

Ни один технический писатель не знает всех технических деталей.

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

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

Подготовка документов

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

1. Технические отчеты

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

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

2. Технические руководства

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

Примеры: руководство по эксплуатации автомобиля; инструкция по эксплуатации будильника; руководство разработчика программы для ЭВМ

3.Электронная почта

Электронная почта

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

Пример: электронное письмо, отправленное всем сотрудникам с обновленной информацией об изменениях политики управления персоналом.

4. Технические предложения

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

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

5. Технические характеристики

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

Пример: архитектор предоставляет строительному подрядчику спецификации на строительство дома.

6. Лист технических данных

Таблицы технических данных

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

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

7. Руководства и справочники

Руководства и справочники — это ссылки или наборы инструкций в легко доступной форме.

Пример: Справочник MLA предоставляет краткое справочное руководство для определенного стиля написания исследований.

8. Стандартная рабочая процедура

Стандартная операционная процедура (СОП) — это набор пошаговых инструкций, обычно предназначенных для сотрудников, для выполнения рутинных процессов. СОП направлена ​​на повышение согласованности, качества и соответствия повторяющихся операций.

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

Написание правильного стиля

Наконец-то можно начинать писать! Пройдя этот вдумчивый процесс планирования, написание станет проще и эффективнее.

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

Активный голос

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

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

Активный Пример: Обученный техник считывает счетчик шесть раз в год.

Точный выбор слов

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

Пример: Если индикатор мигает, инициируйте жесткий перезапуск, нажав кнопку питания.

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

Подход, основанный на задачах

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

Структура предложения

Всегда помещайте самую важную информацию в главное предложение. Читатель лучше усвоит приоритетную информацию.

Пример: Исследователи высказали предварительные опасения, но испытание антибиотика было успешным.

Улучшено: Испытание антибиотика прошло успешно, несмотря на предварительные опасения исследователя.

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

Пример: Крайне важно сливать воду из водяного насоса после каждого использования. Если не слить, насос подвергнется коррозии.

Улучшено: Во избежание коррозии важно сливать воду из водяного насоса после каждого использования.

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

Улучшено: Продажи в первом квартале снизились из-за политической нестабильности в регионе.

Избегайте жаргона

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

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

Пример: ВОЗ дает четкие директивы по использованию лекарств от малярии.

Улучшено: Всемирная организация здравоохранения (ВОЗ) дает четкие директивы по использованию лекарств от малярии.

Использовать простой язык

Plain language имеет собственный набор международных руководств. Главный вывод — писать так, чтобы любой читатель мог понять текст.

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

Пример: В настоящее время наши исследования сосредоточены на использовании этого препарата для полной ликвидации кори.

Улучшено: В настоящее время , наши исследования сосредоточены на использовании препарата для устранения кори.

Визуальное форматирование

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

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

Ясность форматирования

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

Шаблоны

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

Улучшение с помощью соответствующей графики

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

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

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

Для более глубокого обсуждения прочтите наш пост о графике для технического письма.

Внимательно рассмотрите

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

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

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

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

Технический обзор

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

Цикл обзора

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

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

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

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

• Начните свое путешествие по техническому письму
• Создайте свое портфолио
• Уточните свое резюме

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

Карьерный совет

Вам нужна степень в области технического письма?

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

Просто начни писать

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

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

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

Знай, чего ты стоишь

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

Министерство труда США сообщает, что средняя зарплата технического писателя в США в 2016 году составляла 69 850 долларов или 33,58 доллара в час.

Сосредоточьтесь на своей нише

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

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

Внештатный сотрудник или штатный сотрудник

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

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

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

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

Где искать работу

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

• LinkedIn
• Upwork
• Remoteok.io

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

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

Непрерывное образование

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

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

Например, в Викиверситете есть бесплатный вики-курс по написанию технической документации. Мы предлагаем онлайн-курс написания технических отчетов под руководством инструктора, чтобы улучшить техническое письмо (в дополнение к другим нашим курсам делового письма).Этот курс представляет собой практикум; в ходе курса вы создадите актуальный технический отчет.

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

Присоединяйтесь к профессиональной ассоциации

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

Последние мысли

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

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

Чтобы узнать больше о техническом письме, посетите дополнительные ресурсы:

Вступая в эту прибыльную область

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

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

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

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

Моя работа в группе по обработке документов по информационным технологиям для подрядчика федерального правительства за пределами округа Колумбия платит 70 000 долларов — почти вдвое больше, чем я зарабатывал на моей последней работе в газете.

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

Чем занимается технический писатель?

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

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

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

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

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

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

Сколько вы можете заработать как технический писатель?

Средняя зарплата технического писателя составляла 72 850 долларов в мае 2019 года, согласно Справочнику по профессиональным перспективам, выпущенному U.С. Бюро статистики труда.

Это больше, чем зарабатывают сопоставимые профессионалы СМИ, такие как редакторы, писатели, авторы и специалисты по связям с общественностью (их средняя заработная плата составляет не более 60 000 долларов США), и значительно больше, чем то, что получают репортеры, корреспонденты и аналитики новостей вещания (при средней заработной плате 46 270 долларов США).

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

Согласно справочнику по профессиональным перспективам, благодаря продолжающемуся буму научно-технической продукции в США в период с 2019 по 2029 год будет создано 4300 рабочих мест в сфере технических коммуникаций. (Прогноз для категории репортеров на тот же период предполагает сокращение позиций на 5800, снижение на 11%).

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

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

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

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

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

• Умение писать четко, лаконично и в нейтральном стиле
• Любопытство
• Аналитический ум
• Простота взаимодействия с занятыми учеными, инженерами, иллюстраторами, исследователями, аналитиками безопасности и различными малыми и средними предприятиями

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

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

Выздоравливающие журналисты также естественны для перехода к технической литературе. Любой, кто работал в отделе новостей, вероятно, является экспертом в проведении интервью с профильными экспертами (SME), в том числе уважающим время SME, но также готовым задать дополнительные вопросы или даже «глупые» вопросы, если некоторые важные вещи остаются неясными. Они знают, как важно стремиться к совершенству — от грамматики и пунктуации до всех технических деталей — но все же сдают работу вовремя.

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

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

Как перейти к техническому письму

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

Другие стратегии подготовки к техническому письму включают:

• Прохождение бесплатных онлайн-курсов в Центре технической коммуникации Угура Акинджи или из другого авторитетного источника
• Поступление в колледж или университет, который предлагает курсы технического письма или даже степени. Глобальный кампус Университета Мэриленда — один из хороших онлайн-вариантов.
• Ознакомьтесь с Techwhirl, онлайн-ресурсом с информацией, полезной для опытных ветеранов технических коммуникаций, а также студентов и начинающих профессионалов.
• Связь с работающими профессионалами через группу технических писателей LinkedIn, Technical Writers United и другие группы на Facebook
• Создание резюме только для технических писателей.

Вам тоже захочется почитать о технических письмах. Том Джонсон, технический писатель из Калифорнии, который начал свой блог I’d Rather Be Writing более десяти лет назад, составил список ресурсов, которые он назвал 40 Основными книгами для технического письма. Он включает в себя «Процесс технического письма» Кирана Моргана и другие руководства по началу работы в технической сфере, а также два классических произведения, идеально подходящих для писателей всех мастей: «О хорошем письме» Уильяма Зинссера и «Элементы стиля» Странка и Уайта.”

Итак, каково быть техническим писателем?

Сокращение технического письма: это немного скучно.

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

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

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

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

Фото через Дина Дробота / Shutterstock
ссылки
нет
1

Об авторе: Кристин Снайдер

Кристин Снайдер начала профессионально писать в старшей школе, освещая спорт для ежедневной газеты в своем родном городе. Она перешла в технический писатель после газетной карьеры, которая включала работу в The Charleston Gazette, крупнейшей газете Западной Вирджинии, и работу редактором в The Plain Dealer в Кливленде.Она также пишет статьи для раздела «Стиль» в The Washington Post и журнала Grit. Ее адрес электронной почты [адрес электронной почты защищен]

Работа технического писателя: обычный день и как им стать

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

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

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

Чем занимается технический писатель?

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

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

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

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

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

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

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

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

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

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

1. Навыки, необходимые для технического писателя

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

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

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

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

2. Заработная плата технического писателя

Заработная плата технического писателя достаточно хорошая. В среднем они зарабатывают 74 650 долларов в год, что составляет около 36 долларов в час. Как и в случае с любой другой работой, оплата зависит от вашего опыта и клиентской базы.

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

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

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

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

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

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