Кар'єра в IT : посада Technical Writer

Представляємо десяту статтю серії «Кар'єра в IT». У цій частині циклу поговоримо про посаду технічного письменника - посередника між розробниками продукту і кінцевими користувачами. Попередні матеріали циклу були присвячені посадам Team Lead , Software Architect , Project Manager , CTO , QA engineer , QA Automation engineer , Бізнес-аналітик , Системний адміністратор і Data Scientist/Machine Learning Engineer .

Технічний редактор - це фахівець, який складає технічну документацію (інструкції з експлуатації для користувачів, ТЗ для розробників і т.д.) на всілякі програми і автоматизовані системи.

За даними ДОП, середньому українському технічному письменникові 28 років, у нього 3,5 роки досвіду роботи і зарплата $ 400-1400. Співвідношення жінок і чоловіків на цій посаді - приблизно 50/50.

Завдання та обов'язки

Основне завдання 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 & amp; Manual, RoboHELP, MadCapFalre, MadCap Software (розробка електронної довідки), AuthorIT, DocBook/XML, DITA, SiberSafe (автоматизація документування ), Adobe FrameMaker, Microsoft Word, OpenOffice (підготовка технічних публікацій), робота з IDEF0, DFD- і ER-діаграмами, UML.

«Мені здається, що технічна освіта все ж краще. Але в нашій країні у цій професії більше лінгвістів ».

Перспективи кар'єрного розвитку технічного письменника:
- Рости як Technical Writer, заглиблюватися в спеціальність;
- Вертикальний зростання: стати керівником підрозділу технічних письменників;
- Перекваліфікуватися в бізнес- аналітика, тестувальника або верстальника (якщо більше цікавить технічна сторона);
- Рухатися в маркетологи або PR-відділ (якщо більше приваблює творчість).

«Більшість іде в бізнес-аналіз, як вчинив і я. Але знаю приклади того, як колишні технічні письменники ставали успішними проектними менеджерами на дуже великих проектах ».

PS Дякуємо за допомогу в написанні статті 6 українським технічним письменникам, які поділилися з DOU таїнствами своєї професії. Наведені в статті цитати взяті з їхніх розповідей.

Решта статті циклу:
- Кар'єра в IT: посада Team Lead
- Кар'єра в IT: посада Software Architect
- Кар'єра в IT: посада Project Manager
- Кар'єра в IT: посада CTO
- Кар'єра в IT: посада QA engineer
- Кар'єра в IT: посада QA Automation engineer
- Кар'єра в IT: посада Бізнес-аналітик
- Кар'єра в IT: посада системний адміністратор
- Кар'єра в IT: посада Data Scientist/Machine Learning Engineer

Опубліковано: 12/03/15 @ 10:50
Розділ Різне

SEO Блог