Сайт документации doc.yandex-team.ru — это внутренний сервис Яндекса, на котором публикуется техническая документация к сервисам и проектам Яндекса. Эта документация содержит конфиденциальную информацию и предназначена только для внутреннего использования сотрудниками Яндекса.
Главная страница
На главной странице сайта содержится каталог документов, состоящий из ссылок на документы. Названия документов в каталоге сгруппированы по сервисам или направлениям, к которым они относятся.
Слева от ссылки с названием документа может отображаться пиктограмма, указывающая на особый статус документа:
новый документ;
документ обновлён;
доступ к документу ограничен.
По ссылке с названием документа выполняется переход на первый раздел документа.
Страницы с разделами документа
Документы доступны в html- и pdf-версиях.
Печатная версия документа открывается по ссылке В формате PDF, расположенной вверху справа. Рядом со ссылкой находится пиктограмма
.
Html-версия документа представляет собой набор веб-страниц, каждая из которых содержит один раздел документа.
Слева располагается содержание документа, состоящее из названия направления или сервиса, к которому относится документ, и иерархической структуры разделов документа (на самом верхнем уровне содержится название документа).
В центральной части отображается заголовок и текст открытого раздела документа.
В тексте разделов документа могут встречаться пиктограммы, обозначающие примечания к тексту.
Пиктограммы примечаний
Примечания содержат информацию разного характера: предупреждение, рекомендацию, важную или дополнительную информацию. Для каждого типа информации используется своя пиктограмма примечания:
— предупреждение: «Внимание!», «Осторожно», «Опасно»;
— важная информация: «Важно», «Ограничение»;
— дополнительная информация: «Примечание», «Замечание», «Быстрый путь»;
— рекомендация: «Совет», «Напоминание».