Самая крупная мультиформатная конференция для тимлидов и руководителей

30 ноября 2023 и 1 декабря 2023

Москва, Кампус СКОЛКОВО

Задокументировать всё

KnowledgeConf: Передача знаний в командах

Доклад принят в программу конференции

Мнение Программного комитета о докладе

Если вы в очередной раз не смогли найти, как у вас что-то работает, и первой мыслью было «А давайте всё задокументируем!», то Семён поможет разобраться, какие задачи стоят за этой фразой на самом деле, как уметь эти задачи понимать, между собой различать и выбирать подходящее решение.

Целевая аудитория

СТО, тимлиды, разработчики — технические специалисты любых уровней, которым необходимо создавать документацию, но это не является их профильной активностью. Этот доклад НЕ целит в техписателей и/или системных аналитиков, излагаемые в докладе темы им уже известны.

Тезисы

«Хочу всё задокументировать» — нормальное состояние тимлида. Мы все прекрасно понимаем, что хорошая внутренняя документация решает множество проблем команды разработки:
* структурирует внутренние коммуникации;
* снижает bus factor;
* удешевляет онбординг;
* снижает риски архитектурных ошибок при эволюции проекта.

Но во фразе «задокументировать всё» оба слова имеют множество смыслов, причем довольно нечетких.

Что значит «задокументировать»? Какой набор документов мы считаем необходимым и достаточным? Кто и как пишет эти документы?

Что значит «всё»? Как мы определяем необходимое «документационное покрытие» предметной области проекта?

В этом докладе мы:
* поговорим о том, как тимлиду осмыслить и детализировать (в первую очередь для самого себя) задачу по наведению порядка в документации;
* обсудим требования к типовым документам в команде разработки;
* рассмотрим случаи, когда для решения задач тимлида нужен не переполненный информацией Confluence, а всего один-два документа.

Пять лет писал на C++, а потом добровольно и осознанно стал техническим писателем (да, так бывает!).
С 2012 до 2018 руководил отделом технической документации в Zodiac Interactive.
В 2018 году основал компанию по заказной разработке документации и консалтингу в этой области.

documentat.io

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

Видео