Профессиональная конференция по управлению знаниями

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

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

Пять значений фразы «нам нужно всё задокументировать»

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

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

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

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

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

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

Тезисы

Последние пять лет мы (documentat.io) занимаемся заказной разработкой документации для российских IT-компаний.

Разговор с почти каждым из наших клиентов начинается с фразы «нам нужно всё задокументировать, помогите нам в этом».

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

В нашей практике такого рода просьбы сводятся к пяти направлениям работы:

- Описание требований к уже существующей системе (реверс-инжениринг требований).
- Создание пользовательской документации.
- Создание архитектурной документации, адресованной исключительно разработчикам.
- Создание API-документации (причем обычно речь идет о вводных и обучающих статьях (howtos/tutorials), а не к непосредственному написанию аннотаций к методам или правке Сваггера).
- Комментарии в коде (в стиле Javadoc или в свободном формате).

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

Этот доклад адресован в первую очередь тем, для кого написание документации НЕ является основной рабочей активностью: разработчикам, менеджерам и тимлидам.

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

documentat.io

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

Видео