# Общие сведения

DaaS (Documentation-as-a-Service) — это сервис обработки и хостинга документации Яндекса. DaaS позволяет командам хранить документацию на порталах документации, а также получать и встраивать ее в интерфейсы своих продуктов. Документы можно получать как полностью, так и по частям.

# Основные возможности

# Разные исходные форматы

DaaS предоставляет хостинг для документации, собранной из исходных форматов различными сборщиками (списки форматов и сборщиков постепенно пополняются).

Исходный формат | Сборщик
--- | ---
Markdown | Mkdocs / Cloud
DITA | Yoda
Wiki | DaaS
RST | Sphinx
Python | Sphinx
Спецификация swagger 2.0 json/yaml | Yod
Спецификация openapi 3.0 json/yaml | Yod

# Варианты публикаций на разных доменах

DaaS позволяет публиковать документацию, собранную из разных исходных форматов:

На портале документации

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

  Пример с сервисом Коллекции: Документация Коллекций на общем портале.

На домене сервиса

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

  Пример с сервисом Такси: Документация на сервисе.

На домене сервиса и на портале документации одновременно

  Документ публикуется на домене сервиса и на портале документации. Объединяет преимущества двух способов, перечисленных выше.

  Когда документ публикуется на домене сервиса, дубли страниц внутри порталов документации получают канонические URL, которые указывают на страницы на домене сервиса. То есть для внешних поисковых машин остаются только страницы сервиса. Внутренний поиск по порталу (например, поиск по порталу support), наоборот, про внешние дубли ничего не знает.

  Пример с сервисом Погода: Документация на сервисе и Документация на общем портале.

На хостах DaaS
  Документ публикуется на хостах вида . Такой вариант публикации актуален для документации из wiki или если вы хотите отдельный внутренний сайт с документацией.

# Кастомизация

У DaaS есть API, с помощью которого можно получать:

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

# Поиск по документации

DaaS использует технологию поиска SaaS и строит поисковый индекс. Для документации доступен поиск по документации и саджест.

# Примеры документов

Документ | Исходный формат | Место хранения | Хостинг | Способ получения контента
--- | --- | --- | --- | ---
AppHost | Markdown | Arcadia | Внутренний портал документации | —
Статистика | RST | Arcadia | Внутренний портал документации | —
Bringly | DITA | SVN | URL сервиса | API
Sentry | Wiki | Wiki | Отдельный URL | —
Яндекс.Касса | DITA | SVN | URL сервиса | —