Сайт документации

Сайт документации — это структурированная база знаний по вашему продукту: руководства, инструкции, справочник, описание архитектуры, примеры кода. Слева — дерево разделов, сверху — поиск, у статей — оглавление и ссылки между собой; можно вести несколько версий документации. Это шире центра помощи (там короткие статьи-ответы для поддержки пользователей, см. «Центр помощи») и шире API-документации (там только описание эндпоинтов, см. «API-документация»): документация — про то, как продукт устроен и как с ним работать, целиком. Готовые движки (Docusaurus, GitBook, MkDocs) подходят для типовой документации; свой сайт нужен, когда документация должна быть неотделимой частью продукта — единый вход с продуктом, аналитика по статьям, интеграция с поддержкой и CRM, свой бренд без чужого логотипа и ежемесячной платы. Базовая цена — от 100 000 ₽ за стартовую структуру с поиском и разовым переносом контента; версии, многоязычность и сложные интеграции считаются отдельно.

• Документация разбросана по PDF, Notion и Google-докам — пользователь не находит нужное и пишет в поддержку.
• Поддержка отвечает на одни и те же вопросы — нет единой базы с поиском.
• Документация устаревает: нет версий, непонятно, что актуально для какой версии продукта.
• Текущая дока выглядит чужеродно — без вашего бренда и удобной навигации.

• Структура: дерево навигации, боковое меню, оглавление статей, хлебные крошки
• Контент: руководства, инструкции, справочник, примеры кода с подсветкой и копированием
• Поиск по всей документации — быстрый, с подсказками
• Версии документации: несколько версий продукта параллельно (опционально)
• Удобное ведение контента: markdown или админка, правки без вёрстки
• Адаптив, тёмная тема, быстрая загрузка; ссылки между статьями
• SEO-основа: статьи индексируются и приводят трафик из поиска
• Интеграции: обратная связь к статьям, аналитика, многоязычность (опционально)

• Пользователи и разработчики сами находят ответы — меньше обращений в поддержку
• Единая база знаний с поиском вместо разрозненных файлов
• Несколько версий документации — каждому понятно, что актуально для его версии продукта
• Документация под вашим брендом, индексируется и приводит трафик из поиска

• Оставляете заявку и описываете продукт, структуру и версии документации
• Проектируем структуру, навигацию, поиск и ведение контента
• Разрабатываем, переносим материалы и запускаем

• Чем сайт документации отличается от центра помощи и API-документации?

  Сайт документации — это продукт целиком: гайды, инструкции, справочник, архитектура, примеры кода. Центр помощи — короткие статьи-ответы для поддержки пользователей (как пользоваться, что делать при проблеме). API-документация — только описание эндпоинтов для разработчиков. Часто они часть одного портала, но это разные форматы и разный объём.

• Чем свой сайт лучше готовых движков (Docusaurus, GitBook)?

  Готовые движки быстры и дёшевы для типовой документации — часто их достаточно. Свой сайт нужен, когда документация должна быть неотделимой частью продукта: единый вход с продуктом, аналитика по статьям, интеграция с поддержкой и CRM, нестандартный UX, свой бренд без чужого логотипа и без ежемесячной платы.

• Сколько стоит и от чего зависит цена?

  Базовая цена — от 100 000 ₽ за стартовую структуру с поиском и разовым переносом контента. Несколько версий, многоязычность, сложные интеграции и большие миграции считаются отдельно. Рассчитываем после описания задачи.