Як стати Technical Writer. План дій для початківців

Technical Writer — це професія, що поєднує в собі гуманітарний та технічний напрями. В університетах такої спеціальності не навчають, проте техрайтери потрібні у багатьох ІТ-компаніях.

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

Хто такий Technical Writer

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

Згідно з останнім опитуванням DOU, середня зарплата технічного письменника в Україні — $1750. Проте, за даними анкет, деякі досвідчені фахівці отримують і понад $3000. Зараз на DOU відкрита 31 вакансія в категорії Technical Writer.

Що входить в обовʼязки

Головне завдання технічного письменника — грамотно створювати, ілюструвати та адаптувати документацію зрозумілою для кінцевого користувача мовою. Матеріал може бути призначений для внутрішніх потреб команди/проєкту або для клієнта продукту. Найважливіший критерій хорошої документації — це коли її читають.

Якщо Technical Writer працює над матеріалом «від розробника — клієнту», то спочатку він вивчає програмне забезпечення, а потім, розібравшись в особливостях його роботи, пише інструкції для кінцевого користувача.

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

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

До кола обов’язків технічного письменника може входити:

  • Створення документації користувача, довідкових систем.
  • Створення документації для адміністраторів систем.
  • Підготовка графічних схем за заданими параметрами.
  • Регулярне оновлення документації згідно з релізами ПЗ.
  • Створення навчальних матеріалів для нових користувачів.

Перед початком роботи Technical Writer зʼясовує, хто саме виступає експертом предметної галузі (Subject Matter Expert) поставленого завдання, і проводить з ним інтерв’ю, під час якого дізнається подробиці про продукт або сервіс. Потім аналізує, розкладає систему на елементи й видає результат кінцевому користувачеві у вигляді документації.

Технічним письменникам часто доводиться спілкуватися з програмістами та Product Owner’ом або іншим менеджером. Останній зорієнтовує, що варто додати до документації, які матеріали можна використовувати для написання, яких вимог щодо її оформлення треба дотримуватися. Програмісти допомагають розібратися у технічних деталях.

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

Особливості професії

  • Ця позиція поєднує гуманітарний напрям з технічним. Технічними письменниками стають як філологи, які цікавляться ІТ, так і технарі, які добре володіють словом.
  • Робота передбачає постійну комунікацію з колегами, тому підходить тим, хто любить спілкування.
  • Є професійне зростання, адже технічний письменник з часом починає добре розумітися на технологіях, про які пише.
  • У роботі технічного письменника майже немає місця для творчості. У технічній документації не повинно бути двозначних висловів. Все обумовлено стандартами, навіть порядок слів і типи речень.
  • Більшість робочого часу техрайтера займає не написання документації, а підготовка до цього: збір інформації, спілкування з фахівцями, вивчення стандартів та продукту.

Що потрібно знати та вміти технічному письменнику

Англійська мова. Це обовʼязкова навичка техрайтера, оскільки технічна документація, за деякими винятками, має бути написана або продубльована англійською. У всіх вакансіях в категорії Technical Writer на DOU вимогою є знання англійської мови, починаючи від рівня Upper-Intermediate.

Програма для написання тексту та налаштування зовнішнього вигляду документації. Якщо ви вмітимете працювати в одній з таких програм, то легко вивчите будь-яку іншу за потреби. Це може бути щось із цього:

  • MadCap Flare;
  • Adobe Robohelp;
  • HelpNDoc;
  • Doc-To-Help;
  • Help & Manual;
  • Help Generator;
  • Sandcastle;
  • AsciiDoc.

Збірка правил про те, як писати текст. Сюди входить граматика, правила форматування, термінологія тощо. Наприклад, Microsoft Manual of Style, Chicago Manual of Style, Apple Style Guide. Повністю вивчити навіть один такий мануал складно. Це робиться поступово, роками, у процесі роботи. Якщо чогось не знаєте, це не критично, тому що завжди можна підгледіти інформацію в інтернеті.

Програми для створення та редагування скриншотів. Наприклад, Snagit, Screenpresso, Snipping Tool, Madcap Capture та інші.

Програма для створення діаграм, схем. Наприклад, Visio, Photoshop, Illustrator.

Системи, що допомагають працювати у команді над одним проєктом. Вони зберігають завдання всіх співробітників, внутрішню документацію, історію змін у коді та багато іншого. Наприклад, Redmine, Jira, Request Tracker (RT), Visual Studio, Git, Confluence тощо.

Програми для перекладу тексту іншою мовою. Наприклад, MemoQ, MateCat.

Базові знання HTML, XML, CSS, SQL.

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

Щоб стати технічним письменником в IT-компанії, необхідно бути терпеливим та уважним до деталей. Вміти працювати з отриманою інформацією — розкладати по поличках архітектуру багаторівневих систем. Швидко розбиратися в технічних аспектах і описувати їх у зрозумілому вигляді.

Важливо мати системне аналітичне мислення, комунікативні навички.

Цієї спеціальності не навчають в університетах, а тому майбутній техрайтер має освоїти професію самостійно. Важливо багато практикуватися — наприклад, описати функціональність якоїсь програми й дати почитати комусь з родичів, не повʼязаних з IT. Важливо, щоб вони легко розібралися у вашій інструкції.

Де вчитися та що читати

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

Technical Writing для початківців. Онлайн-курс українською мовою, що містить огляд основних складових професії техрайтера: обов’язки, види документації, особливості технічного тексту, інструменти тощо. Крім того, допомагає визначитися, чи підходить вам професія техрайтера взагалі.

Easy Way to Technical Writing. Безкоштовний відеокурс, що охоплює теоретичну інформацію про технічне письмо, граматику, лексику та пунктуацію у поєднанні з різноманітними завданнями від фактичних API та навчальних посібників.

Як створювати та оформлювати технічну документацію в IT. Стаття стане в пригоді як початківцям — людям, які щойно прийшли у професію і хочуть її опанувати, з чого починати та яких помилок уникнути, — так і техрайтерам, які вже встигли попрацювати та набити ґуль.

Технічна комунікація та технічне письмо: точки перетину та старт кар’єри. Стаття про те, що таке технічне письмо та як стати технічним комунікатором.

12 Technical & Business Writing Power Techniques for Success. Техніки, описані в цьому курсі, може використовувати будь-який автор, який хоче писати ефективніші документи та звіти.

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

Вам залишилось тільки почати. Успіхів у освоєнні нової професії!

За допомогу у підготовці статті дякуємо Ярославі Качан, Technical Writer в MacPaw.

Підписуйтеся на Telegram-канал «DOU #tech», щоб не пропустити нові технічні статті.

👍ПодобаєтьсяСподобалось19
До обраногоВ обраному5
LinkedIn



11 коментарів

Підписатись на коментаріВідписатись від коментарів Коментарі можуть залишати тільки користувачі з підтвердженими акаунтами.

Гарна стаття. Прокоментую деякі речі:
• «мати гарні знання в тій галузі, про яку пише» — в ідеальному світі. В реальності треба ставити запитання тим, хто розбирається.
• «Базові знання HTML, XML, CSS, SQL.» — дійсно треба, але я б не виділяв це жирним. Не є головною вимогою.
• «Крім власне написання, технічний письменник в разі потреби оновлює документацію.» — а оце я б виділив жирним і червоним. Важливо думати про оновлення перед початком роботи. А також думати про тих, хто буде оновлювати після того, як ви припините роботу на проекті.
• «з’ясовує, хто саме виступає експертом» — питає на мітингу: «Хто може з цим допомогти?» XD
• «Останній зорієнтує, що варто додати до документації ... яких вимог щодо її оформлення треба дотримуватися.» — Зазвичай, технічні спеціалісти мають інший погляд на продукт і виконують свою роботу. Їм норм, коли працює. Дивитись на документацію очима читача і розуміти що треба додати це вже робота письменника. Вимоги до оформлення це також компетенція письменника. Частіше треба запропонувати варіанти, а не питати як оформлювати, бо багатьом і чернетка в Google доці буде good.
• «підходить тим, хто любить спілкування» — робочі моменти не завжди є тим приємним спілкуванням, до якого всі прагнуть. Тут головне не сприймати review як критику і брати до уваги коментарі. Колега свіжим поглядом завжди побачить щось, що можна доопрацювати. Треба прийняти коментарі, внести зміни і подивитись що вийде, а не захищати свій «ідеальний» док у паперовій битві.
• «майже немає місця для творчості» — творчій підхід полягає у тому, щоб зробити текст цікавим, зрозумілим і корисним дотримуючись всіх жорстких вимог. Як зазначив в автор: «Найважливіший критерій хорошої документації — це коли її читають.»
• «Є професійне зростання, адже технічний письменник з часом починає добре розумітися на технологіях, про які пише.» — тут слабкий зв’язок. Професійне зростання пов’язане зі знанням процесів, інструментів і підходів. Технології на проектах можуть бути різними. У технологіях розуміються SME — з’ясовуйте хто це і проводьте інтерв’ю. А потім наполегливо вимагайте від них technical review 😉

Sorry, guys, it feels much easier to post a comment in English, since we are talking about writing things anyways.
Personally, being a copywriter and content manager, I get to write about loads of things, including “how to” instructions, quite technical articles, etc. Hence, I wouldn’t focus on aiming at the technical writer as such but on a more universal approach, especially in the IT domain.
And true, it is all about DIY and self-learning plus loads of practice.

«Technical Writer зобов’язаний мати гарні знання в тій галузі, про яку пише...» — не зовсім так. Іноді треба писати про досить специфічний домен. Гарні знання у цій сфері потрібно отримувати роками. Важливо вміти правильно опитати носіїв знань і викласти це зрозумілою мовою для читача документації.

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

Згодна, але подекуди це залежить від компанії. Ми спілкувались з техрайтерами, до чиїх обов’язків це входило.

Так буває, що техрайтер суміщає обов’язки БА. Але це окремий кейс, а не правило. Часто-густо техрайтерів намагаються використовувати не за призначенням )) Наприклад: вести мітінг ноутс на зустрічах, робити презентації в пауер пойнті, писати копірайтерські тексти чи статті на ДОУ замість, наприклад, архітектора чи СТО ))

Хм, для копірайтерських статей ніби має бути копірайтер :)

Логічно, так) Але у баченні деяких компаній, техрайтер — це перекладач, копірайтер, дизайнер, секретарка і бог зна що ще.

А це вже Technical Communicator. Що є цікавим напрямком і гарною альтернативою.

Technical Writer або Technical Communicator можуть виявляти потреби клієнта в рамках своїх компетенцій і це гарна практика. По суті це і є бізнес аналіз, у вужчому полі. В ідеальному світі, задача BA з’ясувати, чи є потреба у залученні технічного письменника, а далі вже письменник сам з’ясовує що, як, у якому форматі, якими інструментами, для кого, що ще може знадобитись, дедлайни, та інше.

я би це не додавав:

Photoshop, Illustrator

бо є багато інших сервісів, набагато цікавіших

Підписатись на коментарі