Technical writing что это
technical writing
Смотреть что такое «technical writing» в других словарях:
Technical writing — Technical writing, a form of technical communication, is a style of formal writing, used in fields as diverse as computer hardware and software, chemistry, the aerospace industry, robotics, finance, consumer electronics, and biotechnology. Good… … Wikipedia
technical writing — composing technical professional literature … English contemporary dictionary
Technical communication — is the process of conveying usable information through writing or speech about a specific domain to an intended audience. Information is usable if the intended audience is able to perform an action or make a decision based on its contents… … Wikipedia
Technical writer — A technical writer is a professional writer who designs, writes, creates, maintains, and updates technical documentation mdash;including online help, user guides, white papers, design specifications, system manuals, and other documents. Engineers … Wikipedia
Technical lettering — Not to be confused with Technical writing. Technical lettering is the process of forming letters, numerals, and other characters in technical drawing. It is used to describe, or provide detailed specifications for, an object. With the goals of… … Wikipedia
Writing process — The Writing process is both a key concept in the teaching of writing and an important research concept in the field of composition studies. Research on the writing process (sometimes called the composing process) focuses on how writers draft,… … Wikipedia
writing — Synonyms and related words: alphabet, alphabetic character, art, article, artistry, authorcraft, authorship, autograph, automatic writing, best seller, black and white, blank, blueprint, book, bound book, brainchild, cacoethes scribendi,… … Moby Thesaurus
WRITING — (Scripts, Materials, and Inscriptions). SCRIPTS AND MATERIALS General Survey From the end of the third millennium B.C.E., the art of writing was practiced in the ancient Near East (see alphabet ). Here, the pictographic, cuneiform, and… … Encyclopedia of Judaism
Technical debt — (also known as design debt or code debt) are synonymous, neologistic metaphors referring to the eventual consequences of poor software architecture and software development within a codebase. Common causes of technical debt include (a combination … Wikipedia
Technical terminology — is the specialized vocabulary of a field. These terms have specific definitions within the field, which is not necessarily the same as their meaning in common use. Jargon is similar, but more informal in definition and use, while legal terms of… … Wikipedia
Как мы нанимали технического писателя
Меня зовут Нина Золотова, я технический писатель Parimatch Tech, сама не один раз проходила собеседования на эту позицию, затем проводила их, поэтому знаю процесс найма с обеих сторон. Теперь хочу поделиться, как мы это делаем и на что обращаем внимание.
Опыт показывает, что с тем, кто такой техрайтер и зачем он нужен, многие уже разобрались, а вот как его нанимать — ещё нет. Особенно если ни одного техрайтера в компании до этого не было.
«Болтал сегодня с инженерами и ПМами во время ревью документа и они такие:«У нас это впервые — совсем новый для нас процесс». Не перестает удивлять, насколько люди не знакомы с работой техрайтера и документацией. Наверное, я – роскошь.» — Том Джонсон, техрайтер, автор блога I’d rather be writing и разработчик курса по документированию API.
Например, в одном из мест, куда я собеседовалась, в описании вакансии просто поставили ссылку на статью на DOU с комментарием: «Вот тут все правильно написано, у нас требования точно такие же». А в качестве тестового задания попросили прямо на собеседовании записать по памяти любой кулинарный рецепт на двух языках.
В другой компании после первого разговора с HR собеседовал меня архитектор. Мы немного поговорили о тех документах, которые я готовила на предыдущих проектах, потом я как-то интуитивно спросила: «А в чем у вас проблема с документами?» и дальше все собеседование сидела и с интересом просто слушала про то, что у них на тот момент болело.
Кого мы искали
Ещё до начала собеседований мы между собой обсудили, каким представляем себе идеального кандидата. Если перевести с языка требований вакансии на человеческий, то мы ждали человека:
с техническим образованием
хотя бы с небольшим опытом работы в IT, причем необязательно техрайтером — вполне подошло бы и что-то смежное, например UX-райтер или тестировщик. Желательно чтобы он слышал про языки разметки текста и мог начертить хоть какую-то диаграмму
в идеале также хотелось видеть опыт аналитика у кандидата
с грамотным письменным русским и английским
Рассчитывали на миддла или сильного джуна, были готовы обучать при необходимости.
Почему так? Дело в том, что на тот момент у нас уже была небольшая команда, относительно налажены процессы, подобраны инструменты, разработаны шаблоны (потом мы все сломали, но об этом, наверное, в другой раз). Нам был нужен человек, который впишется в команду, быстро вникнет в то, что мы тут делаем, будет при этом достаточно самостоятельным и инициативным, его не нужно будет контролировать на каждом шагу. Сложился такой стиль управления: ставят конечную цель, но как её достичь — это уже полностью на усмотрение сотрудников, а стремление самому найти себе задачу поощряется.
Поэтому знание конкретных инструментов или стандартов ушло на второй план. Считаю, все это можно выучить при наличии мотивации и здоровой любознательности. К тому же, инструменты и стайлгайды могут меняться от проекта к проекту. Если человек их знает — хорошо, если нет — тоже не страшно, разберется в процессе.
Если бы пришлось писать документацию с нуля или налаживать процессы, то и требования предъявлялись бы иные, но наш кейс был вот таким.
Кто пришел на самом деле
На позицию подалось 48 кандидатов, среди них: техрайтеры, копирайтеры, специалисты техподдержки, ПМы, маркетологи, бизнес-аналитики, переводчики и даже редактор глянца. Из них 10 прошли прескрин у HR и добрались до технического собеседования, 6 согласились сделать тестовое задание, четверо его таки сделали, по результатам тех. собеседования двое получили оффер (не одновременно).
В их числе пришла девушка, которая казалась тем самым идеальным кандидатом — мифическим «единорогом», соответствующим всем пунктам требований. До этого я искренне считала, что так вообще не бывает. У неё был техрайтерский опыт, потом она поработала аналитиком в стартапе, с её слов немного выгорела на этой работе и решила вернуться к документации. С позиции экспертных знаний, опыта, грамотности, человеческих качеств все было отлично, она выполнила тестовое, получила оффер… и отклонила его настолько вежливо, что мы даже сохранили это письмо как эталон максимально дипломатичного отказа.
Тестовое задание
Вопрос, давать или не давать тестовое задание, выполнять его или не выполнять — очень спорный, на этот счет есть противоположные точки зрения. Когда мы решили предлагать кандидатам тестовое, то понимали и принимали риски, что какое-то количество хороших кандидатов отсеется просто потому, что не захотят его выполнять. Но все-таки, о техрайтере лучше всего говорят написанные им документы, без них оценивать сложно.
Если кандидат мог показать документы, которые написал раньше, то мы, конечно же, тестовое не требовали.
Тестовое задание у нас было такое:
Написать пользовательскую инструкцию, как сделать ставку на сайте компании. Язык — английский.
Не обязательная часть. Изобразить этот процесс в виде схемы/диаграммы в любой выбранной нотации.
На что мы обращали внимание при его оценивании:
Хороший технический документ — грамотный, понятный, логичный, консистентный, выдержан в едином стиле
В нем легко найти нужную информацию, потому что он структурирован, разбит на шаги, есть подзаголовки, важное выделено.
Есть скриншоты или другие иллюстрации, они аккуратно оформлені
Инструкция рабочая — если сделать все как в ней написано, то действительно получится поставить ставку.
Пример замечательного внутреннего документа с бинго из фраз, которые не хотел бы услышать ни один техрайтер: «никто не напишет», «по-разному, смотря где» и «сейчас все забыли». Сам документ по форме и по содержанию отличный. Человек, который так пишет, нас бы точно очень заинтересовал (но он уже работает в компании).
В тестовом задании кандидата, который получил в итоге оффер, лично меня окончательно подкупила именно диаграмма — явно далекая от идеального и нарисованная впервые в жизни. Это и было важно — человек искренне постарался в очень короткий срок разобрался в новом для себя и сделал максимально хорошо, хотя это было вообще не обязательно.
Пример тестового, как мне кажется, хорошо иллюстрирующий, чем отличается текст техрайтера и копирайтера, показывали недавно в техрайтерском телеграм-канале. Задача была написать сравнительную характеристику проводных и беспроводных охранных систем.
Копирайтерский текст будет скорее всего красивый, с отсылками к истории систем, упоминаниями про стильный дизайн в интерьере и удобное приложение для управления.
Вопросы на собеседовании
Самым главным качеством для хорошего технического писателя я считаю здоровую любознательность. Ему не обязательно со старта досконально разбираться во всех технических вопросах, но у него должен быть виден как минимум интерес к ним, желание разобраться как можно подробнее, узнать как можно больше, даже если в итоговый документ войдет всего 10% полученной информации.
Какие вопросы задавали:
Выясняли общетехнический уровень — что такое фронтенд и бекенд, что такое микросервисная архитектура, что такое html и xml и чем они отличаются
Умеет ли человек объяснять сложное простыми словами — объяснить, что такое API, своей бабушке
Какие типы документов уже приходилось писать? Что самое сложное было в работе над ними? Критерии хорошего документа?
С чего начнете работу над новым документом, новой задачей?
Разработчики, архитекторы и прочие эксперты часто неразговорчивы или слишком заняты. Как вы будете добиваться информации от них, если они сопротивляются?
Как относитесь к задачам типа «пойди туда не знаю куда, принеси то, не знаю что»?
Что нравится в работе, что не нравится? Есть ли какие-то задачи, которые вообще неприемлемы?
Есть ли какие-то интересы, смежные с техрайтерством, например, управление знаниями, UX-райтинг? Если они есть, это очень положительный сигнал.
Единственно правильных ответов на эти вопросы нет, их цель скорее понять образ мышления человека, что он из себя представляет и насколько ему это всё интересно. Было действительно интересно наблюдать, как одни люди потухают на этих вопросах, когда понимают, что нет готового однозначного ответа, а другие, наоборот, загораются, включаются, начинают размышлять. Собственно, в качестве будущих коллег я для себя рассматривала только людей второго типа.
Кого мы в итоге наняли
Итак, мы провели все собеседования, потом выписали в столбик всех кандидатов, каждый из команды проставил им свою личную оценку в баллах, сравнили результаты и дали оффер кандидату с наивысшей суммой оценок.
Скажу честно, результат отличался от той картинки, которую мы себе нарисовали вначале. У выбранного кандидата было нетехническое образование и вообще по технической части немножко меньше знаний, чем мы ожидали, но при этом его сильные стороны с лихвой это все компенсировали (например, отличное знание инструментов переводчика и серьезный опыт работы с юридическими документами на английском). И самое главное — был виден искренний интерес к делу и здравый перфекционизм.
Сейчас прошло уже почти полгода, можно оценивать успешность найма — кандидат отлично прошел испытательный срок, быстро подтянул свои пробелы в знаниях и очень усилил нашу команду, в одиночку вывозит некоторые проекты.
Надеюсь, наш опыт поможет, если вы будете искать себе технического писателя. Конечно же, perfect match будет зависеть от специфики ваших задач. Если наличие определенного навыка у кандидата принципиально важно, то в этом не стоит идти на компромисс, потому что такой компромисс может и не окупиться.
Бонус
Когда создаешь в таск-трекере задачу под названием Библия, просто невозможно удержаться от шуточек на эту тему
Если хотите побольше узнать про создание технической документации, кроме упомянутого в начале статьи блога Тома Джонсона рекомендую:
На Youtube-канале documentat.io есть отличный курс лекций, который дает общее понимание, что это и зачем, охватывает основные инструменты и стандарты
Телеграм-канал Technical Writing 101 регулярно публикует всякие полезные штуки для техрайтеров
Карьера в IT: должность Technical Writer
Представляем десятую статью серии «Карьера в IT». В этой части цикла поговорим о должности технического писателя — посредника между разработчиками продукта и конечными пользователями.
Технический писатель — это специалист, который составляет техническую документацию (руководства по эксплуатации для пользователей, ТЗ для разработчиков и т.д.) на всевозможные программы и автоматизированные системы.
Задачи и обязанности
Основная задача Technical Writer — грамотно создавать, иллюстрировать и адаптировать документацию на понятном для конечного пользователя языке. Материал может предназначаться для потребностей команды/проекта (внутренняя) или для клиента продукта (внешняя).
«Главная обязанность позиции технического писателя — сделать документацию такой, чтобы ее читали».
Особенности работы технического писателя могут немного различаться в зависимости от поставленной задачи:
— Если этот специалист работает над материалом «от разработчика — клиенту», то сначала он изучает существующее ПО, а затем, разобравшись, пишет инструкции для конечного пользователя.
— Если в работе материал «от клиента к разработчику», то технический писатель вместе с бизнес-аналитиком оценивает потребности клиента, и затем доносит это до разработчиков в понятной им форме в виде спецификации или технического задания.
«Технические писатели — специалисты, которые технически сложные вещи могут объяснить простым человеческим языком, понятным конкретной аудитории. Они умеют писать, и одновременно разбираются в технике и технологиях».
Technical Writer обязан обладать глубокими знаниями в той области, о которой пишет, и уметь выражать суть максимально подробно и, вместе с тем, лаконично. Важно уметь работать с иллюстрациями — делать и обрабатывать скриншоты, создавать понятные графики, схемы, диаграммы. Также часто, особенно для работы с онлайн-справкой, необходимо иметь хотя бы базовые навыки HTML.
В круг обязанностей технического писателя может входить:
— Создание пользовательской документации, справочных систем;
— Создание документации для администраторов систем;
— Подготовка графических схем по заданным параметрам;
— Регулярное обновление уже существующей документации в соответствии с релизами ПО;
— Создание учебных материалов для новых пользователей.
«Фактически, технический писатель сталкивается не только с технической документацией, а и с другими материалами. Иногда доводится писать, редактировать или переводить release notes, software requirements specification, CV, PowerPoint презентации, meeting minutes, user stories и даже технические книжки, а также записывать обучающие how-to видео туториалы».
Основные инструменты технического писателя — текстовый редактор, диктофон, а также, в зависимости от особенностей проекта, руководства MS Manual of Style, Apple Style Manual, Chicago Manual of Style, программы MS Word, Adobe FrameMaker (для создания оффлайн-материалов), Adobe RoboHelp, MadCapFalre (для онлайн-документации) и другие.
Прежде всего, Technical Writer узнает, кто именно выступает экспертом предметной области (Subject matter expert) поставленного задания, и проводит с ним интервью — узнает все подробности про новый функционал. Затем анализирует, раскладывает систему на простейшие элементы, и в виде документации выдает результат конечному пользователю.
«Чаще всего я тесно работаю с программистами и product owner’ом. Последний дает общее направление по новинкам, которые следует включить в документацию, какие материалы корректно использовать, какие общие требования по оформлению документации согласно требованиям конкретного региона следует соблюсти. Программисты помогают мне разобраться в сути новых опций».
Типичный рабочий день Technical Writer включает в себя:
— Всестороннее изучение того, что должно быть включено в документацию в будущем (если релиза продукта еще нет);
— Создание новой документации для непокрытой функциональности;
— Обновление документации.
«Я занимаюсь написанием руководства для пользователей десктопного приложения, мне нужно понятно и доступно донести до них техническую информацию. Так как я почти всегда пишу „по живому“ (когда проект находится еще в стадии разработки), я волей-неволей выполняю функцию тестера. Но баги не репорчу сама, а сообщаю о них тестерам. Знаю, что в некоторых компаниях техписатели могут сами репортить баги».
Достоинства и недостатки
Привлекает технических писателей то, что эта позиция помогает совместить гуманитарное направление с техническим. Technical writer’ами становятся как филологи, интересующиеся ИТ, так и «технари», не готовые заняться непосредственно разработкой или технической работой, но хорошо владеющие словом.
«Сейчас я понимаю, что это работа не для всех. Чтобы быть tech writer’ом, недостаточно просто уметь писать. Документация — это специфический жанр, который нужно понять, принять и не отклоняться от него, если хочешь добиться результатов. Он не терпит фривольностей».
«Я всегда хорошо писала и свободно владею иностранным языком. Должность технического писателя оказалась идеальным компромиссом между возможностью писать, не терять языковые навыки, и достойно зарабатывать. А еще я очень люблю общаться. Моя работа предполагает постоянное общение с программистами и менеджерами, — в некоторой степени это и привлекло меня в эту профессию».
«Очень приятен процесс профессионального роста. Начинаешь понимать технические штучки, потихоньку осваиваешь язык разметки».
Основным недостатком писатели-гуманитарии обозначили проблему невозможности творчества, а писатели с техническим складом ума — отсутствие непосредственного карьерного роста в техническую сторону.
«Главный минус специальности — ограничение в способах выражения. Техническая документация не позволяет свободных фраз. Все обусловлено стандартами manual of style, даже порядок слов и типы предложений. Впрочем, если полёт мыслей в тексте — не ваш конёк, и вместо того, чтобы выдумывать, вам проще написать в рамках правил, тогда техническая документация — для вас».
«Самый главный недостаток для меня — невозможность влиять на функциональность ПО. Только описание уже созданной функциональности».
«Не все понимают суть работы технического писателя и потому считают, что могут вкладывать в нее „новые обязанности“. 80% времени технический писатель занимается всем, чем угодно, только не техническим писательством».
Также упоминали о пренебрежительном отношении со стороны программистов:
«Некоторые девелоперы вообще не считают написание документации работой, им ведь и так все понятно — есть комментарии к коду. У них никогда нет времени на сотрудничество, хотя достаточно всего часа в неделю, чтобы техническому писателю было с чем работать».
Как стать техническим писателем и куда идти дальше
Чтобы стать техническим писателем в IT-компании, необходимо быть усидчивым, терпеливым и внимательным к деталям. Уметь работать с полученной информацией — раскладывать по полочкам архитектуру многоуровневых систем. Быстро разбираться в технических аспектах и описывать их в виде, подходящем для понимания конкретной аудиторией.
Не менее, чем системное аналитическое мышление, важны и коммуникативные навыки, умение общаться.
«Нужно уметь задавать разработчикам правильные вопросы, чтобы досконально изучить возможности ПО».
Что касается профессиональных знаний, то этой специальности не учат в университетах, а потому будущий tech writer должен освоить профессию самостоятельно: прочитать Microsoft Manual of Style, исследовать стиль написания документации больших технических компаний, научиться грамотно, последовательно, доходчиво и стилистически правильно излагать информацию.
«Важно много практиковаться — например, описать функциональность MS Word и дать почитать кому-то из старших родственников. Если они без проблем действуют по вашей инструкции — поздравляю, у вас есть задатки для tech writing!».
Для тех, кто хочет работать в аутсорсинговых компаниях, необходимо отличное владение иностранным языком. Базовые знания по HTML, XML, CSS, SQL, представление о системной и программной инженерии будут плюсом.
Стоит ознакомится с основными инструментами и технологическими средствами, которые используют технические писатели: Microsoft HTML Help Workshop, Help&Manual, RoboHELP, MadCapFalre, MadCap Software (разработка электронной справки), AuthorIT, DocBook/XML, DITA, SiberSafe (автоматизация документирования), Adobe FrameMaker, Microsoft Word, OpenOffice (подготовка технических публикаций), работа с IDEF0, DFD- и ER-диаграммами, UML.
«Мне кажется,что техническое образование все же предпочтительней. Но в нашей стране в этой профессии больше лингвистов».
Перспективы карьерного развития технического писателя:
— Расти как Technical Writer, углубляться в специальность;
— Вертикальный рост: стать руководителем подразделения технических писателей;
— Переквалифицироваться в бизнес-аналитика, тестировщика или верстальщика (если больше интересует техническая сторона);
— Двигаться в маркетологи или PR-отдел (если больше привлекает творчество).
«Большинство уходит в бизнес-анализ, как поступил и я. Но знаю примеры того, как бывшие технические писатели становились успешными проектными менеджерами на очень крупных проектах».
P.S. Спасибо за помощь в написании статьи 6 украинским техническим писателям, которые поделились с DOU таинствами своей профессии. Приведенные в статье цитаты взяты из их рассказов.
Підписуйтеся на Telegram-канал «DOU #tech», щоб не пропустити нові технічні статті.
Технический писатель: кто это, обязанности, зарплаты и как им стать в 2021 году. Обзор профессии.
Кто такой технический писатель?
Технический писатель (technical writer) — это специалист, который преобразует сложные и технически трудные письменные материалы в четкую и лаконичную документацию, которую будет читать целевая аудитория. Они собирают и разрабатывают техническую информацию для создания инструкций по обслуживанию и эксплуатации, технических и инструктивных руководств, журнальных статей и другой документации для производителей, проектировщиков и клиентов. Технические писатели также могут писать техническое задание (ТЗ).
Что делают технические писатели и чем занимаются?
Обязанности на примере одной из вакансий:
Что должен знать и уметь технический писатель?
Требования к техническим писателям:
Востребованность и зарплаты технических писателей
На сайте поиска работы в данный момент открыто 1 010 вакансий, с каждым месяцем спрос на технических писателей растет.
Количество вакансий с указанной зарплатой технического писателя по всей России:
Вакансий с указанным уровнем дохода по Москве:
Вакансий с указанным уровнем дохода по Санкт-Петербургу:
Как стать техническим писателем и где учиться?
Варианты обучения для технического писателя с нуля:
Ниже сделали обзор 15+ лучших онлайн-курсов.
15+ лучших курсов для обучения технического писателя: подробный обзор
1 место. Курс «Технический писатель» — Skillbox
Технический писатель — это профессионал, который умеет простым языком описать сложные процессы. Например, как пользоваться техническим оборудованием на заводе или CRM-системой в компании. Он составляет руководства, документацию, инструкции, пишет технические задания (ТЗ) для исполнителей.
Кому подойдёт этот курс:
Чему вы научитесь:
Программа
Вас ждут онлайн-лекции и практические задания на основе реальных кейсов.
23 модуля, 54 урока
Основные курсы
Дополнительные курсы
Дипломные проекты
Диплом Skillbox
Подтвердит, что вы прошли курс, и станет дополнительным аргументом при устройстве на работу.
2 место. Курс «Технический писатель» — ФинКонт
Цели семинара/курса:
Профессиональный стандарт «Технический писатель»: содержание и требования:
3 место.Курс «Технический писатель» — B-seminar
Цель курса:
Техническая документация и технический писатель: основные термины и понятия. Введение в проблему.
Единые стандарты документирования.
Виды и стили технических текстов.
Средства и методы создания технических текстов.
Приёмы работы с техническими текстами.
Создание векторных изображений и контроль ошибок в объемных документах.
Процесс перевода технической документации (на примере английского языка).
Программное обеспечение в работе технического писателя.
Курс «Технический писатель. Разработка технических текстов и документации» — ЦНТИ Прогресс
Для кого:
Для специалистов, ответственных за разработку и сопровождение технической документации, технических писателей, IT-специалистов.
Программа: