Технический писатель: создание технической документации
Technical writer: technical documentation development
Представляем уникальный курс, направленный на подготовку специалистов в области разработки технической документации. Благодаря освещению в рамках курса самых актуальных теоретических вопросов касательно технического писательства и закреплению навыков на практике слушатели научатся писать технические тексты, следовать правилам и стандартам. Выполненную итоговую работу слушатели могут использовать как образец при устройстве на работу.
Ближайшая группа
Для физ.лиц
Для организаций*
*Для оформления заказа от организации обращайтесь по тел. +7(495) 780-48-44
Преподаватели
Алымова Александра Евгеньевна
Чурикова Светлана Юрьевна
Описание курса
Хотите научиться сложное объяснять доступно и понятно? Хотите работать по высоким стандартам, принятым в крупных компаниях? Нацелены освоить секреты мастерства технического писателя? Тогда этот курс для вас!
Сегодня на рынке остро не хватает технических писателей. Их функции зачастую выполняют инженеры или журналисты, поскольку первые хорошо разбираются в предмете, а вторые хорошо умеют писать. Не удивительно, что созданные ими тексты зачастую не отвечают предъявляемым высоким требованиям, поскольку инженеры не очень хорошо пишут, а журналисты являются скорее лириками, чем физиками, поэтому не могут в полной мере рассказать о технических решениях.
Технический писатель – сравнительно молодая профессия, возникшая и оформившаяся в середине прошлого века. Техписатель – создатель текстов, рассказывающих о том, как работает тот или иной механизм или электронная машина, программное обеспечение, телефония и т.д. Он может создавать инструкции и сопроводительные документы, задания, руководства пользователей, формуляры, техтребования или большие технические статьи, СНиПы, ГОСТы и многое другое. Во многом, технический писатель сродни переводчику. Он должен уметь достаточно просто объяснить сложные вещи. Для этого необходима специальная подготовка.
Нет образовательного учреждения, где бы технических писателей готовили столь же фундаментально, как, к примеру, писателей обычных или журналистов. Техписателей готовят те, кто уже прошёл серьёзный путь в этой профессии и может поделиться накопленными знаниями. Именно такие педагоги-практики работают в Центре «Специалист» и научат вас на этом курсе всему, что знают сами.
Представляем вам уникальный авторский курс, направленный на подготовку специалистов, обладающих навыками написания технических текстов. Пройдя обучение, вы получите знания и практические навыки работы с техническими документами. Благодаря большому количеству практических занятий, вы научитесь работать с документацией, писать тексты различных стилей на техническую тематику и легко сможете применить приобретенные умения в реальных рабочих условиях.
Компетенции, которые вы приобретёте в процессе обучения:
Новички смогут овладеть профессией с нуля, уже работающие в этой области смогут пополнить багаж знаний, систематизировать их, овладеть наработками мастера с многолетнем стажем.
Освойте востребованную профессию на профессиональном уровне. Приходите в «Специалист».
Технический писатель
Вы научитесь разрабатывать техническую документацию по отраслевым стандартам. Будете писать грамотные и понятные технические тексты и узнаете, как презентовать себя работодателю.
Технический писатель это профессионал, который умеет простым языком описать сложные процессы. Например, как пользоваться техническим оборудованием на заводе или CRM-системой в компании. Он составляет руководства, документацию, инструкции, пишет технические задания (ТЗ) для исполнителей.
сейчас ищут технического писателя
зарплата начинающего специалиста, по данным hh.ru
Кому подойдёт этот курс
Новичкам
Познакомитесь со всеми этапами работы технического писателя. С нуля научитесь взаимодействовать с заказчиками, писать технические тексты и сможете брать заказы на фрилансе.
Тем, кто учится писать технические тексты
Опытный преподаватель поделится универсальными знаниями о профессии, которые позволят вам работать над широким кругом задач, а не ограничиваться отдельной нишей.
Чему вы научитесь
Планировать рабочий процесс
Будете оценивать, сколько времени требуется для работы над документацией в различных жанрах. Организуете рабочий процесс в Trello.
Пользоваться инструментами
Познакомитесь с важными для писателя функциями Microsoft Word, освоите OneDrive, Google Документы, языки разметки. Получите технические навыки: познакомитесь с HTML, CSS и git.
Работать с фактурой
Узнаете, как подготовиться к интервью с техническими специалистами, правильно задавать вопросы и вести конспекты. Научитесь собирать информацию из чертежей, таблиц, графиков.
Писать грамотные тексты
Познакомитесь с правилами стилистики, типографики и будете структурировать текст так, чтобы неподготовленный читатель всё понял. Облегчите общение между разработчиками ПО и нетехническими специалистами в компании.
Разрабатывать и адаптировать документацию
Будете создавать технические задания, паспорта, технические условия, руководства по эксплуатации и онлайн-справки. Оформлять проекты по стандартам ГОСТ, ISO, IEC и IEEE.
Презентовать себя как специалиста
Добавите в портфолио работы, которые сделаете на курсе. Сможете доказать свою ценность и полезность работодателю.
Подарки от партнёров на Чёрную пятницу
О Skillbox
Как проходит обучение
Изучаете тему
В курсе — практические видеоуроки.
Выполняете задания
В том темпе, в котором вам удобно.
Работаете с преподавателем
Закрепляете знания и исправляете ошибки.
Защищаете дипломную работу
И дополняете ею своё портфолио.
Программа
Вас ждут онлайн-лекции и практические задания на основе реальных кейсов.
Основные курсы
Технический писатель. Базовый уровень
Технический писатель-дизайнер
Технический писатель PRO
Дипломные проекты
Дополнительные курсы
Система контроля версий Git
Дипломные проекты
Руководство по эксплуатации
Оформите документ по ГОСТу с применением оглавления, стилей, сквозной автонумерации, перекрёстных ссылок.
Получить презентацию курса и консультацию специалиста
Похоже произошла ошибка. Попробуйте отправить снова или перезагрузите страницу.
Ваша заявка успешно отправлена
Преподаватель
Александра
Занина
Опыт в профессии — 3 года. Работала над технической документацией для интернет-магазина, буровых установок, радаров фотофиксации, навигационной аппаратуры.
Отзывы студентов
Если какой-то материал тяжело даётся, есть вопрос по ДЗ, достаточно написать преподавателю, который поможет разобраться с информацией и подскажет как решить задачу.
По итогу 9-месячной учебы стал по-другому смотреть на сайты. Замечаю «баги», разбираюсь в вёрстке, веду репорты. Узнал, как работать со специфическим ПО.
Уже сейчас нисколько не жалею, что выбрал Skillbox. Спасибо.
Валентина Нарушевич, г. Санкт-Петербург
Благодаря урокам я научилась создавать классные постеры и векторные изображения.
Также мой список новых скиллов пополнили ретушь и обтравка изображений — одни из главных навыков профессионального графического дизайнера.
Ну и умение верстать журналы! Теперь я, как самый настоящий графический дизайнер, с легкостью могу создать разворот какого-нибудь модного журнала.
Яна Щербицкая, г. Санкт-Петербург
Курс очень круто структурирован, там есть все знания, которые мне нужны, чтобы освоить программу. Сама бы я точно что-нибудь пропустила.
Преподаватели всё спокойно и терпеливо объясняют. Если ты что-то не понял, снимут дополнительный видеоролик и покажут ещё раз.
Самое крутое в курсах Skillbox — постоянная связь с теми, кто подскажет, как правильно.
Мой сайт
Алла Комиссаренко, г. Москва
Работать дизайнером мне очень нравится, от UX я вообще в восторге, тяга к аналитике у меня была всегда. После долгих поисков работы в новой сфере подруга помогла мне получить заказ на редизайн сайта большой компании.
Отдельно хочу сказать спасибо преподавателю Александру Свобода, он очень подробно расписывал все недочёты и ошибки решений в дизайне.
Мой сайт
Елена Кальво, г. Ницца, Франция
«Почему бы не сделать из хобби источник заработка?», — однажды подумала я.
Недолго размышляя, записалась на курс в Skillbox и встала в ряд претендентов на гордое звание копирайтера.
Работа с текстом помогла мне вернуть свою жизнь, вдохновила. Я начала снова ухаживать за собой, читать. Увидела, что я не только мать, но и писатель.
Читайте мои тексты в Instagram
Ирина Семёнова, г. Бельцы, Молдова
Я узнала, что такое охваты, KPI и прочие непонятные слова, которые пугали в группах по SMM. Поняла, что чем проще и понятней, тем лучше. Разобралась в сложной иерархии рекламного кабинета и научилась настраивать аудиторию и рекламу.
Я уже в теме и не боюсь назвать своих более опытных друзей коллегами.
Мой дипломный проект
Ваше резюме после обучения
Профессиональные навыки:
Диплом Skillbox
Подтвердит, что вы прошли курс, и станет дополнительным аргументом при устройстве на работу.
Стоимость обучения
Рассрочка на 12 месяцев
Оставьте заявку и узнайте у менеджера про скидку на курс и подарки от партнёров
Похоже произошла ошибка. Попробуйте отправить снова или перезагрузите страницу.
Ваша заявка успешно отправлена
Часто задаваемые вопросы
У меня нет опыта работы с технической документацией. Подходит ли мне курс?
Есть ли какие-нибудь требования к студенту?
Какой график обучения? Получится ли совмещать его с работой?
Сколько часов в неделю мне нужно будет уделять учёбе?
Я смогу общаться с преподавателями?
Действуют ли какие-нибудь программы рассрочки?
Получите консультацию и курс в подарок при покупке
Мы свяжемся с вами и ответим на любые возникшие вопросы
Похоже произошла ошибка. Попробуйте отправить снова или перезагрузите страницу.
Ваша заявка успешно отправлена
Записаться на курс
Наш специалист свяжется с вами и ответит на любые ваши вопросы
Похоже произошла ошибка. Попробуйте отправить снова или перезагрузите страницу.
Ваша заявка успешно отправлена
Спасибо за заявку!
Наш менеджер свяжется с вами
в ближайшее время
Купите со скидкой 1378 ₽ или оформите рассрочку
Похоже произошла ошибка. Попробуйте отправить снова или перезагрузите страницу.
Условия рассрочки
Сумма первых 5 платежей поступит на Ваш счет, с которого будет списываться плата за обучение.
Ваши собственные средства начинают списываться только с 6 месяца обучения
г. Москва, Ленинский проспект,
дом 6, строение 20
Профессия технический писатель
Это хорошая профессия для людей, желающих работать на стыке технического и гуманитарного направлений. В отличие от копирайтинга, здесь меньше творчества и больше регламентов. В данной статье мы расскажем, кто такой технический писатель и что входит в его обязанности, как стать таким специалистом и где искать работу, в том числе удаленно.
Содержание статьи:
Кто такой технический писатель и чем он занимается?
Технический писатель – это специалист, который создает документацию к программам, интернет-сервисам, оборудованию и устройствам. Это могут быть как документы для инженеров и разработчиков, так и руководства для пользователей. Например, инструкция к смартфону, ноутбуку, метеостанции.
В функции технических писателей входит подготовка ТЗ, руководств, инструкций и других документов. По ним люди, которые будут пользоваться программами или оборудованием или участвовать в их доработке, смогут разобраться, что и как устроено и как работает. Технический писатель – это профессия, которая требует ответственности.
В должностные обязанности технического писателя входит:
Подготовка отчетов о проделанной работе.
Иногда в обязанности технических писателей включают работу над интерфейсами, локализацию. Например, необходимо перевести интерфейс программы с английского языка. Технический писатель подбирает термины на русском языке, которые наиболее близки к оригиналу, чтобы пользователи поняли, где и какие функции находятся.
Также в функции технических писателей включают подготовку простых графиков и диаграмм, скриншотов, учебных видео материалов. Иногда им поручают создание статей и рекламных материалов, хотя эту работу должен выполнять копирайтер.
Плюсы и минусы профессии технического писателя
Развивает системное мышление.
Сложности в карьерном росте. Если вы не желаете работать на руководящих должностях, это не будет для вас минусом.
Сколько зарабатывают технические писатели?
Зарплата начинающего технического писателя начинается от 40 тыс. руб. в месяц. Средняя зарплата специалиста с опытом 2-3 года – 60-80 тыс. руб. в месяц. Специалисты, создающие документацию на английском языке, могут получать больше 150 тыс. руб. в месяц. Например, так платят в ИТ-компаниях, которые создают софт для западных рынков.
Технический писатель может работать как в офисе, так и удаленно, а также быть фрилансером. Средние цены на создание технической документации – от 500-1000 руб. за страницу (1800 знаков с пробелами). Например, разработка технического задания у фрилансера может стоить от 20 тыс. рублей, руководства для администратора – от 25 тыс. рублей. При заказе в компаниях эти документы будут стоить в 2 раза дороже.
Что должен знать и уметь технический писатель?
Желательно знать английский язык.
Как стать техническим писателем с нуля?
В эту профессию приходят двумя путями. Первый – человек с техническим образованием понимает, что разработка и проектирование – это не его. Решает вместо работы инженером попробовать себя в новой сфере. Второй путь – человек с гуманитарным образованием желает работать в технической сфере, но не программировать. Тогда он становится писателем.
Если вы новичок, то можете поискать вакансии с минимальными требованиями на HH.ru. Например, для создания онлайн-справок могут взять человека без технического образования и опыта. Так вы сможете постепенно погружаться в предметную область, осваивать новые задачи и профессионально расти.
Бесплатные курсы для технический писателей проводятся в Академии Гипербатона от компании Яндекс. Обучение занимает 1 месяц. Для поступления необходимо справиться с тестовым заданием. Лучшим выпускникам могут предложить работу.
Будет полезно читать книги, например, «Разработка технической документации» Вадима Глаголева. Это справочник, в котором собраны ссылки на ГОСТы и выдержки из них.
Много информации для начала карьеры в профессии можно найти на форуме технических писателей Techwriters.ru и на YouTube.
Где искать работу?
Посмотрите открытые вакансии в местных ИТ-компаниях, интеграторах, разработчиках софта. Часто они набирают стажеров, которых потом могут брать в штат.
Новая роль в команде: технический писатель
Привет! Я Катя, руководитель группы технических писателей в Ozon. Сейчас нас уже 9 человек и целая платформа документации, но коллеги всё ещё не всегда понимают, чем мы занимаемся.
Из непонимания появляются запросы вида: “Хотим себе собственного техписателя в команду, но не знаем, чем именно он будет заниматься”. В итоге команда подстраивается под тренды и заводит себе документацию, но через пару месяцев оказывается, что доку не читают, а техписатель плавно превратился в аналитика.
Поэтому пришло время делиться опытом и рассказывать о каких-то концептуальных штуках 🙂
Кто вообще такие технические писатели?
Встречала разные ответы, от «ребята, которые пишут никому не нужные талмуды по ГОСТам» до вполне близких к моей реальности определений.
В Ozon технические писатели занимаются глобально тремя направлениями:
пользовательской документацией (Помощь, База знаний, FAQ),
документацией внешних API,
описанием внутренних систем — от онбордингов до сложных архитектурных взаимодействий.
Какое в итоге «правильное» занятие для техписа — поле для холивара — в Ozon вот так, в других компаниях может быть иначе. Когда я работала в Яндексе, например, конкретно моя команда не сильно занималась внутренними документами.
Ещё к нам часто приходят просто за качественными текстами — для лендингов, постов, обучающих курсов. Нам интересно, и мы не отказываем, но не могу сказать, что это попадает под именно техническое писательство.
При желании мы можем писать в принципе любые тексты, но будьте готовы, что от техписателя текст получится с уклоном в техническую часть, без завлекающих и рекламных заголовков.
Технические писатели описывают, как устроены какие-то системы и как с этими системами работать. Это может быть пользовательская инструкция по оформлению возврата или схема взаимодействия методов API — но это всегда ответ на вопрос «как что-то сделать».
Как понять, что пора заводить технического писателя?
Если у вас есть продукт, которым пользуется кто-то снаружи — час пробил. Даже если «снаружи» сидит в соседней команде. Любое погружение посторонних в ваш продукт или проект уже подразумевает документацию, а, следовательно, и позицию технического писателя.
Но есть нюансы:
Документации нет и это не создаёт никаких реальных проблем — техписатель не нужен.
Документацию уже кто-то пишет и ему проще делать это самостоятельно, чем объяснять техписателю — у вас уже есть технический писатель, только называется он «инициативный разработчик» или «ответственный аналитик».
В системе часто что-то меняется — чаще, чем приходится систему кому-то объяснять — проще рассказать на словах, чем поддерживать все изменения. Часто можно сказать: «Ребята, сейчас используем вот эту штуку, документация на официальном сайте», а не расписывать подробные инструкции, которые через пару месяцев уже будут не нужны.
Подумайте о документации как о продукте — оцените её потенциальную аудиторию и задачи, которые она должна решать. Возможно, вам нужна не документация а вебинар, скринкаст. Или даже стикерпак.
Где искать технических писателей и как оценивать кандидатов?
Я пришла в техписательство после бакалавриата компьютерных наук в Иннополисе, года автоматизированного тестирования и академии от Яндекса.
Кто-то приходит из лингвистов и филологов со стремлениями уйти в аналитику или разработку. Я стараюсь искать (особенно стажеров) по техническим вузам; там довольно много ребят, осознавших, что кодить 24/7 — не их стезя. А вот что-то рядом, но чуть гуманитарнее — наш идеальный кандидат.
Если нужен сильный специалист, который всё вам сделает под ключ — профильные сообщества, митапы. Если хватит и молодого, зеленого, но перспективного — чаще всего это кандидат совсем без опыта, но с сильным тестовым и пониманием мира IT.
Если это ваш первый технический писатель на проекте, дайте что-то про описание процесса или архитектуры. Оцените полноту описания, структуру и термины, которые использует кандидат. Прочитайте Ильяхова или подпишитесь на рассылку о текстах, чтобы примерно понимать, где хорошо, а где не очень. Но важнее, чтобы устраивало конкретно вас и попадало в формат компании, чем полное соблюдение концептов информационного стиля и 10 баллов по Главреду.
Как выстроить процесс?
Чаще всего у документации есть заказчик. Это может быть менеджер, разработчик, дизайнер — любой человек, осознавший, что есть какая-то проблема в понимании происходящего. Задача техписателя — определить, реальна ли проблема и в каком формате её нужно решать.
В общем виде документация создаётся по такому сценарию:
Определить цель документа и его аудиторию.
Набросать структуру, согласовать с заказчиком. Скорее всего, изменения будут, здесь важнее понять какие вопросы хочет покрыть заказчик.
Понять, кому и по каким темам можно задавать уточняющие вопросы — найти экспертов и договориться о формате работы с ними.
Наполнять документ и параллельно отдавать на вычитку коллегам-техписателям и экспертам.
Финализировать структуру и тексты — обязательно отдать кому-то на вычитку и после этого презентовать заказчику.
Этапы не должны затягиваться. Если пошёл уже пятый круг обсуждения структуры документа, который ещё даже не начали наполнять — что-то пошло не по плану. Финальное согласование с окончательной заморозкой структуры и текста происходит только тогда, когда уже всё написано и проверено.
Ещё один тонкий момент — что именно может править заказчик. Оговорите это сразу, при постановке задачи: важно, чтобы заказчик не пытался переписать ваш текст согласно своему субъективному взгляду. Факты и термины — да, тут он эксперт, но вкусовщину надо учиться фильтровать.
Часто слышу, что технический писатель, особенно если он один на проекте, просто сидит и что-то пишет целыми сутками, без вычиток и конкретных задач. «Ну он же технический писатель, пусть и пишет всё сам» — бесспорно, существуют люди, которым комфортно работать в таком режиме, но в очень редких случаях это ведёт к хорошей документации и довольному сотруднику.
Моя формула найма: 1.5 техписателя на проект. За половинку может считаться стажер или техписатель из другой команды — так есть и с кем экспертизой обменяться, и кто на время отпуска-болезни подхватит проекты.
Нужен ли вам техписатель: чеклист
Чтобы понять, действительно ли вам нужен технический писатель, задайтесь вопросами:
Кому может понадобиться документация к моему проекту? Моим же разработчикам, внешним пользователям?
Как проблема отсутствия документации решается сейчас? Система понятна и без дополнительного описания? Может, кто-то уже снял обзор по этой теме на YouTube?
Если документация всё же нужна, в каком виде её будет удобно потреблять? Всплывающие подсказки, вебинары, отдельный URL с базой знаний?
Чем будет заниматься технический писатель, когда напишет документацию? Продолжит её актуализировать? Перейдёт на соседний проект?
Начинайте поиски технического писателя, только если у вас сложилась общая картинка о месте документации в вашем проекте. Отнеситесь к документации как к полноценному продукту.
Что дальше?
Дальше — проверять полезность и качество документации, создавать и дополнять стайлгайды, развивать техписателей и повышать общую осознанность компании по теме текстов.
И, конечно же, ждать подробностей в следующих статьях :)
