Документация есть? А если найду?)

А вы были в ситуации, когда нет никакой документации про проекту? Совсем. Я была. И это, кстати, совершенно не редкость - во времена agile и искусственного интеллекта.
В компаниях бытует мнение, что разработка - первична, а описание - не то что вторично, а даже на 10-ом месте. Разработчики часто придерживаются мнения, что документация нужна, но вряд ли инициируют ее создание и поддержание в актуальном виде, тк они могут легко влезть в код и найти ответы на свой вопросы.

Но для бизнеса довольно существенны риски ее отсутствия:

1) в случае смены подрядчика новая команда будет тратить время и финансовые ресурсы компании, чтобы вновь найти ответы на возникающие ранее вопросы и разобраться в кодовой базе.

2) более стрессовая и длительная адаптация новых сотрудников, долгое и разрозненное погружение в продукт. В большинстве компаний погружение в фичи и логику происходит устно, что крайне тяжело для восприятия новичку. К информации хочется вернуться, освежить детали, а обратиться не к чему.

3) "чайка-менеджмент", регулярно одни и те же вопросы от коллег, которые не знают наизусть логику работы фичей. На объяснения одного и того же тратится уйма времени. Запоминания не происходит.

4) появление в коллективе "звезды", которая хранит сакральные знания только в своей голове. Передает их казалось бы охотно, но исключительно устно и в темпе речи, как у Тины Канделаки в программе "Самый умный". Уход такого сотрудника из компании влечет за собой простой в работе и неразбериху.

Лично я очень топлю за создание всех видов документации, поэтому при приходе в компанию начинаю вести ее сама по мере узнавания нового. Чаще всего я пишу пользовательскую документацию, документацию по управлению cms, проектную документацию (техническое задание, план работ), Product Vision. И Roadmap, конечно.

Сейчас для проекта мы создали и используем Wiki для описания документации по CMS. В ней мы придумали структуру по принципу микросервис + сущность сайта:

Быстро найти нужный документ помогает также и Поиск. Названия статей наследуются из задач, тк формируется насмотренность и запоминается ключевое слово, найти их проще.

А теперь немного статистики. Раньше я получала в среднем по 10-15 вопросов в неделю о том, управляется ли тот или иной параметр на сайте настройками или требуется доработка в CMS? Поскольку всех настроек наизусть я не знала (да и просто невозможно их запомнить, тк на проекте очень сложная и обширная CMS), то год назад я переадресовывала 100% вопросов аналитикам, 9 месяцев назад - 50%. Примерно полгода назад я инициировала процесс непрерывного и интенсивного написания документации по CMS аналитиком по тому функционалу, что мной не описан. И сейчас:

- могу уточнить у аналитика 1 вопрос в неделю. А то и в две. На 93% меньше, чем было.

- со временем количество вопросов от коллег сократилось до 2-3 в неделю - на 80%! Но теперь достаточно высылать ссылку на раздел в документации.

Как я отбираю те блоки, которые нужно включить в документацию?

- выгружаю из головы самые популярные и часто возникающие вопросы от коллег. Таким инструкциям - высокий приоритет;

- просматриваю готовые в проде задачи по новому функционалу;

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

Писать или не писать - выбор за вами :)