> For the complete documentation index, see [llms.txt](https://daymonri.gitbook.io/techwritersummary/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://daymonri.gitbook.io/techwritersummary/techdoc/opredelenie-tekhnicheskoi-dokumentacii.md).

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

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

* **realtime** (интерактивные: телефонный разговор, личная встреча);
* **push** (неинтерактивные: общение по e-mail, чат с техподдержкой);
* **pull** (пассивные / по запросу: обращение к базе знаний, wiki-система, видеоинструкция).

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

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

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

***

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

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

***

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

* нарисовать карту стейкхолдеров;
* определить каналы, которые целесообразно реализовать с помощью документации;
* написать документацию для каждого из этих каналов.

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

* понять нужды стейкхолдеров;
* собрать, проанализировать и структурировать информацию;
* спроектировать текстовое представление информации.

{% hint style="info" %}
Техническая документация – всегда про деньги, она экономит средства и снижает риски.
{% endhint %}