Определение технической документации

PMBOK рассматривает техническую документацию в разрезе коммуникаций между стейкхолдерами, деля коммуникации на три типа:

• realtime (интерактивные: телефонный разговор, личная встреча);

• push (неинтерактивные: общение по e-mail, чат с техподдержкой);

• pull (пассивные / по запросу: обращение к базе знаний, wiki-система, видеоинструкция).

Техническая документация – это пассивный способ реализации канала коммуникации между двумя чётко определёнными стейкхолдерами проекта.

Документация возникает тогда, когда остальные способы реализации этого канала коммуникации становятся слишком дороги. Парадокс в том, что сама по себе pull-коммуникация дороже, чем realtime и push. Поэтому она нужна для конкретной пары стейкхолдеров и только в том случае, когда позволяет существенно снизить количество коммуникаций (примеры – курс по онбордингу, документация API, пользовательские инструкции).

Техническая документация – это набор текстовых и графических материалов, описывающих создание, устройство и эксплуатацию продукта.

---

Адресатов всегда больше. Пример – адресаты технической документации API:

• «уже пользовался, нужен конкретный метод» (делаем справочник);

• «вообще не пользовался, хочу научиться» (делаем гайд);

• «не уверен, что буду пользоваться, хочу понять отстройку от конкурентов» (делаем обзор).

---

Алгоритм разработки технической документации:

• нарисовать карту стейкхолдеров;

• определить каналы, которые целесообразно реализовать с помощью документации;

• написать документацию для каждого из этих каналов.

Алгоритм работы технического писателя:

• понять нужды стейкхолдеров;

• собрать, проанализировать и структурировать информацию;

• спроектировать текстовое представление информации.

Техническая документация – всегда про деньги, она экономит средства и снижает риски.