Письменники технічної документації

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

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

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

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

Власне кажучи, аутсорсинг технічного письма це гарантія того, що ви отримаєте якісний контент для вашої проектної/продуктової документації.