Портал онлайн-документации — это веб-ресурс, где размещена различная документация, предоставляемая компанией. Иногда его также называют «порталом поддержки», подразумевая, что это один из технических ресурсов самообслуживания.
Обычно портал документации содержит несколько различных типов контента:
- Документация по программному обеспечению
- Руководства пользователя
- Онлайн-уроки
- Видеоуроки и демонстрации
- Списки часто задаваемых вопросов (FAQ)
- Примеры и статьи с инструкциями
- Базы знаний
- Руководства по устранению неполадок
Ресурсы портала могут быть открытыми, когда они доступны всем пользователям в Интернете без авторизации. Такой подход также способствует привлечению органического трафика из поисковых систем, таких как Google или Bing. Некоторые ресурсы могут быть защищены логином. Этот подход используется, если по каким-либо причинам необходимо предоставить доступ к документации только клиентам или партнёрам. Довольно часто компании комбинируют оба подхода, предоставляя как открытые, так и закрытые ресурсы на своём портале документации.
Это не веб-сайт?
Портал онлайн-документации часто представляет собой очень специализированную CMS (систему управления контентом). Вы по-прежнему создаёте и обновляете контент, привлекаете посетителей, которые потребляют контент через веб-браузер. Однако этот тип программ значительно упрощает создание продуктовой документации и руководств пользователя , содержащих сотни или тысячи страниц по теме, а не отдельные веб-страницы.
Помимо технических различий между CMS и порталом документации, есть важное организационное различие. В отличие от веб-сайта, портал онлайн-документации часто управляется техническими писателями и разработчиками, а не веб-командой и маркетинговым отделом. Как правило, доступ к корпоративному веб-сайту строго контролируется, и администраторы не позволяют изменять содержимое страниц всем подряд. Именно по этой причине портал онлайн-документации часто реализуется с использованием другой технологии и другой системы аутентификации.
Это устраняет зависимость и позволяет разработчикам программного обеспечения обновлять и улучшать документацию по мере необходимости. Выполнять короткие итерации в проектах документации становится значительно проще.