Хто такий технічний письменник (Technical Writer)

Технічний письменник (Technical Writer) - це фахівець, який займається складанням інженерної документації до ІТ-продуктів. Серед зон відповідальності такого співробітника – підготовка технічних завдань для команди розробників, мануалів для користувачів, інструкцій для техпідтримки та багато іншого.

Ця професія потрібна там, де виникає потреба в розробці різних видів документації, в тому числі і в IT-аутсорсингу. 

Що входить до обов'язків технічного письменника в IT-компанії?

Основними обов'язками технічного письменника є написання нової документації та підтримка вже існуючої. Крім цього, в обов'язки входить спілкування із замовниками та командою для з'ясування інформації, яка має бути присутня в документації, та аналіз отриманої інформації.

Як організовано робочий процес технічного письменника?

Технічний письменник не лише пише, а й розмовляє. Щоб створити документацію, перше, що письменник робить, це звертається до своїх колег-спеціалістів (дизайнерів, бізнес-аналітиків, розробників тощо), і з'ясовує, як передбачається користуватися продуктом або тією чи іншою фічею. Після того, як зібрана інформація, технічний письменник аналізує її, відбираючи тільки те, з чим зіткнеться користувач продукту. Після цього приступає до написання інструкції. Не завжди те, що передбачається розробити або покращити, може стосуватися користувача. Ці зміни можуть відбутися в коді і не вплинуть на досвід користувача. У цьому разі письменник не залучається.

Який склад мислення має бути у технічного письменника – технічний чи гуманітарний?

Немає однозначної відповіді це питання. З одного боку, технічний письменник повинен розбиратися в продукті, до якого він пише документацію, а з іншого боку мати грамотну письмову мову, щоб оформити інформацію про продукт у зрозумілу для всіх інструкцію. Проте все приходить із досвідом – «фізики» можуть вивчити мову, а «лірики» розібратися у технологіях. Головне – виявити інтерес, бажання та зусилля.

Чи є у нас зараз вищі навчальні заклади на технічних письменників?

На даний момент у вузах не навчають виключно на технічних письменників. Проте, деякі технічні спеціальності мають навчальний курс, присвячений написанню документації до продукту за ГОСТами. Більшість претендентів навчалися в минулому на лінгвогуманітарних спеціальностях. На ринку також присутні технічні письменники, які раніше навчалися на технічних спеціальностях, опанували мову та прийшли у цю сферу. Претенденти з практичним досвідом також присутні, і цей досвід може бути різноманітний - можливо, що кандидат прийшов з іншої сфери діяльності, або перейшов з іншої IT-спеціалізації.

Чим відрізняється технічний письменник від бізнес-аналітика?

Багато хто чомусь зводить ці професії в одну і думає, що це майже одне й те саме, але це не так. Якщо говорити коротко, професія бізнес-аналітика більше про «Як це працює?», а професія технічного письменника про «Як цим користуватися?». Бізнес-аналітик – це людина на «вході», яка збирає інформацію про те, як працюють окремі частини функціональності та аналізує, наскільки функціональність буде корисною для бізнесу замовника. У свою чергу, технічний письменник – це людина на «виході»: він аналізує інформацію, надану командою та бізнес-аналітиком, після чого приймає рішення, яку інструкцію надати користувачеві, в якому вигляді, що йому буде корисно знати, чого можна очікувати від програми і що треба робити у несподіваних ситуаціях.

Наскільки робота технічним письменником стресова?

Однозначно сказати не можна. Бувають дні, коли ти займаєшся лише стилістичними покращеннями документації, а буває, коли тобі в стислий термін потрібно задокументувати великий обсяг інформації. Технічний письменник завжди зав'язаний на команді, тому все залежить від кількості завдань для розробки і того, як на проекті налаштовані процеси. Якщо задач небагато, чи багато, але процес налагоджений так, щоб виконувати їх рівномірно, то стрес практично не відчутний. Але якщо це великий проект, значущий замовник, великий обсяг завдань та документації, яка має бути виконана «на вчора», то існує великий ризик швидкого вигоряння.

Які вимоги висуваються до технічного письменника на старті кар'єри? Що потрібно знати обов'язково, а які компетенції належать до розряду nice-to-have?

На старті кар'єри від технічного письменника потрібне володіння трьома ключовими навичками: мова, розуміння циклу розробки ПЗ та володіння текстовим редактором. У мовну звичку включається як рівень володіння, так і грамотність.

Що стосується циклу розробки, то від майбутнього технічного письменника очікують розуміння того, які стадії цього циклу, які ролі існують і яка роль безпосередньо технічного письменника. Не обов'язково розумітися на всіх тонкощах відмінностей Scrum і Kanban, але буде плюсом, якщо кандидат має такі знання.

Зрештою, володіння текстовим редактором. Не потрібно знати Word на рівні макросів, якщо цього не вимагають на проекті. Текстовий редактор це просто інструмент. Якщо володіти ним на рівні «можу зробити автозміст» або «можу створити і налаштувати стилі» - цього буде достатньо, та й можна нагуглити і розібратися за невеликий проміжок часу. З розряду nice-to-have читання відповідної літератури про те, як писати документацію. На сьогоднішній день існує 2 «настільні книги» для технічного письменника – Microsoft Manual of Style та Google Developer Documentation Style Guide. Хоча б разок почитати – і в голові буде розуміння, яка документація очікується від майбутнього технічного письменника.

Чи актуальні для технічних письменників градації типу junior, middle, senior?

Градацію позицій технічних письменників іноді вказують, а іноді ні. Можливо, через те, що професія молода і ніхто поки що не зрозумів, за якими критеріями таки треба розмежовувати технічних письменників. За кількістю написаних гайдів не оціниш, за рівнем володіння мовою теж – у різних компаній різний запит на рівень мови, можуть просити «джуна» зі знанням англійської Advanced. Найчастіше зустрічаються позиції без градації.

Яку кар'єру може збудувати технічний письменник?

Якщо зі словосполучення «технічний письменник» розвинути все, що стосується технічних питань, то є багато варіантів розвитку, особливо в рамках ІТ-сфери. Враховуючи знання продукту та можливих варіантів його використання, можна піти у тестування, а можна розвинути комунікативні та аналітичні навички і побудувати кар'єру бізнес-аналітика. Якщо документування передбачає використання програми для розробки документації, де використовується XML/HTML, можна поставити ціль і піти навіть у front-end розробку. Якщо розвивати частину «письменник», можна піти в технічний переклад чи локалізацію. Професія технічного письменника багатогранна, тому можна розвиватися та комбінувати знання для просування кар'єрними сходами або зміни сфери діяльності.