Техническая документация – процесс и артефакт

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

• её нет;

• она есть, но её не читают;

• она есть и её читают, но всё равно приходят с вопросами (потому что она неполная, устарела, неверна).

Документация – это проектный процесс, такой же как code review или deploy. Порой он даже выводится в отдельный столбец на канбан-доске. Но процесс всегда строится вокруг артефакта, в нашем случае – технического документа, который должен иметь конкретные требования для оценки качества.

Постановка задачи на создание технического документа:

• Каких стейкхолдеров мы связываем и зачем? Отвечает бизнес.

• Какую информацию нам нужно передать? Отвечают стейкхолдеры.

• Как лучше всего оформить эту информацию? Отвечает техписатель.

Критерии качества технического документа:

• полнота (передаёт всю необходимую информацию);

• корректность (передаёт верную и актуальную информацию);

• эффективность pull-канал дешевле, чем realtime и push).