🪐 Документация — часть продукта

В прошлом посте я писал, как когда-то боялся показывать документацию до покупки. Сегодня — всё наоборот. Мы относимся к документации как к неотъемлемой части продукта, и в каком-то смысле — даже как к его лицу.

Что изменилось?

Во-первых, удобство работы. Документация легко редактируется, обновляется и версионируется. Вся история — в git. Мы применяем подход documentation as code, и это многое меняет.

Во-вторых, понятность. Мы разбавляем текст картинками, визуальными инструкциями, блоками с примечаниями и гиперссылками. Всё читается легко — как разговор, а не как приговор.

В-третьих, структура. Статьи объединены в руководства, есть навигация, кросс-ссылки, быстрый поиск. Это не просто хранилище — это архитектура знаний.

В-четвёртых, масштаб. У нас обширный массив контента: можно найти ответы на большинство вопросов, изучать разные версии продуктов, отслеживать изменения и сравнивать поведение.

И в-пятых, аудитория. Мы не пишем “в среднем для всех”. У нас есть материалы для операторов данных, стюардов данных, разработчиков, бизнес-пользователей, администраторов, интеграторов и так далее. Каждому — своё.

И всё это — в одном месте, на нашем сайте документации. Там можно не только читать, но и встраивать разделы в продукты, подключать API, добавлять файлы, скрывать ненужные блоки, настраивать всё под себя.

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

Это и есть новая философия: документация — не про то, “что есть”. А про то, “как можно сделать лучше”.

#мыслиCEOвслух