--- metadata: - name: generator content: Diplodoc Platform v5.52.0 alternate: - https://ydb.tech/docs/en/contributor/documentation/structure.md - https://ydb.tech/docs/ru/contributor/documentation/structure.md - href: ru/contributor/documentation/structure.md type: text/markdown title: Markdown version - href: ../../llms.txt type: text/markdown title: llms.txt sourcePath: ru/core/contributor/documentation/structure.md --- > **Documentation Index:** Fetch the complete configuration index at https://ydb.tech/docs/ru/llms.txt # Структура документации YDB Эта статья дополняет [Руководство по стилю документации YDB](https://ydb.tech/docs/ru/contributor/documentation/style-guide.md). Она объясняет текущие директории верхнего уровня документации и какой контент принадлежит каждой из них. Как правило, большинство разделов верхнего уровня фокусируются либо на конкретной целевой аудитории (если названы «Для ...»), либо на конкретном [жанре](https://ydb.tech/docs/ru/contributor/documentation/genres.md). - Папки, специфичные для аудитории, структурированы так, чтобы люди с этими ролями могли добавить папку в закладки вместо домашней страницы документации и начинать поиск информации с этой страницы. - Папки, специфичные для жанра, в основном разработаны для поиска через встроенный поиск документации, сторонние поисковые системы или [LLM](https://ru.wikipedia.org/wiki/%D0%91%D0%BE%D0%BB%D1%8C%D1%88%D0%B0%D1%8F_%D1%8F%D0%B7%D1%8B%D0%BA%D0%BE%D0%B2%D0%B0%D1%8F_%D0%BC%D0%BE%D0%B4%D0%B5%D0%BB%D1%8C). Введение новых папок верхнего уровня возможно, но требует тщательного рассмотрения для минимизации загромождения сайдбара и неоднозначности в отношении того, где должны размещаться статьи. ## Общие правила - Документация YDB многоязычная, и структура файлов для каждого языка должна быть согласованной для корректной работы переключателя языков. Содержимое файлов также должно быть максимально близким между языками. Единственным исключением является папка [«Публичные материалы»](https://ydb.tech/docs/ru/public-materials/videos.md), которая намеренно содержит разный контент для разных языков. Все остальные расхождения между языками считаются техническим долгом. - Поддерживайте консистентность между структурой файлов в репозитории, URL-адресами в адресной строке и папками в боковой панели. Исторически они были независимыми, но опыт показал, что несогласованности приводят к путанице и проблемам с навигацией. Документация постепенно переходит к единой структуре. - Если имя файла или папки содержит несколько слов, используйте `-` вместо `_` в качестве разделителя, если имя не является ключевым словом, включающим подчёркивания (например, [имена разделов конфигурации](https://ydb.tech/docs/ru/reference/configuration/index.md)). - При переименовании или перемещении любой статьи обязательно добавьте перенаправление со старого URL на новый в [redirects.yaml](https://github.com/ydb-platform/ydb/blob/main/ydb/docs/redirects.yaml). ## Список папок верхнего уровня - **[Начало работы](https://ydb.tech/docs/ru/quickstart.md).** [Руководство](https://ydb.tech/docs/ru/contributor/documentation/genres.md#guide) для начинающих, объясняющее, как настроить одноузловой сервер YDB и выполнить на нём первые запросы. - **[Концепции](https://ydb.tech/docs/ru/concepts/index.md).** Высокоуровневый [теоретический обзор](https://ydb.tech/docs/ru/contributor/documentation/genres.md#theory) YDB как технологии, охватывающий его функции, терминологию и архитектуру. Предназначен для широкой аудитории с минимальными предварительными знаниями, включая руководство компаний и лиц, принимающих решения. - **[Для DevOps](https://ydb.tech/docs/ru/devops/index.md).** Папка для DevOps-инженеров, отвечающих за настройку и эксплуатацию кластеров YDB. Большинство контента состоит из [практических руководств](https://ydb.tech/docs/ru/contributor/documentation/genres.md#guide) для конкретных задач, связанных с кластером. Поскольку YDB поддерживает несколько вариантов развёртывания, руководства, различающиеся в зависимости от метода развёртывания, размещаются в соответствующих подпапках ([Ansible](https://ydb.tech/docs/ru/devops/deployment-options/ansible/index.md), [Kubernetes](https://ydb.tech/docs/ru/devops/deployment-options/kubernetes/index.md) или [вручную](https://ydb.tech/docs/ru/devops/deployment-options/manual/index.md)), каждая из которых следует согласованной внутренней структуре. Здесь также включена [теоретическая информация](https://ydb.tech/docs/ru/contributor/documentation/genres.md#theory), специфичная для этой роли. - **[Для разработчиков](https://ydb.tech/docs/ru/dev/index.md).** Папка для разработчиков приложений, работающих с YDB. В основном состоит из [практических руководств](https://ydb.tech/docs/ru/contributor/documentation/genres.md#guide) и [теории](https://ydb.tech/docs/ru/contributor/documentation/genres.md#theory). - **[Для инженеров безопасности](https://ydb.tech/docs/ru/security/index.md).** Папка для инженеров по безопасности, отвечающих за защиту и аудит кластеров YDB и приложений, взаимодействующих с ними. Содержит в основном [практические руководства](https://ydb.tech/docs/ru/contributor/documentation/genres.md#guide) и [теорию](https://ydb.tech/docs/ru/contributor/documentation/genres.md#theory), специфичную для роли. - **[Для контрибьюторов](https://ydb.tech/docs/ru/contributor/index.md).** Папка для участников основной команды разработки самого YDB и внешних контрибьюторов. Она объясняет различные процессы вокруг разработки YDB и предоставляет более глубокое понимание того, как работают некоторые компоненты. В основном [теория](https://ydb.tech/docs/ru/contributor/documentation/genres.md#theory) с несколькими [практическими руководствами](https://ydb.tech/docs/ru/contributor/documentation/genres.md#guide). - **[Справка](https://ydb.tech/docs/ru/reference/index.md).** Подробный раздел со [справкой](https://ydb.tech/docs/ru/contributor/documentation/genres.md#reference) по различным аспектам YDB. Подразумевается, что читатели будут попадать сюда в основном через поиск по мере необходимости или ссылки из других разделов. Основная цель — полнота, чтобы любая тема могла быть найдена через точные совпадения ключевых слов или их описания. Три основных сценария использования этого раздела: - Поиск значения незнакомых ключевых слов, функций, настроек, аргументов и т.д. - Поиск правильного синтаксиса для запросов, работы с SDK или конфигурационных файлов. - Использование как цели для внутренних ссылок, когда другие статьи документации упоминают функциональность без подробного объяснения. - **[Рецепты](https://ydb.tech/docs/ru/recipes/index.md).** Мини-[руководства](https://ydb.tech/docs/ru/contributor/documentation/genres.md#guide), объясняющие конкретные задачи с YDB, часто с примерами и фрагментами кода. Эта папка существует в основном по историческим причинам, так как большая часть её содержимого могла бы быть размещена либо в папках «Для ...», либо в «Вопросы и ответы». - **[Диагностика проблем](https://ydb.tech/docs/ru/troubleshooting/index.md).** Смесь [теории](https://ydb.tech/docs/ru/contributor/documentation/genres.md#theory) о потенциальных проблемах, возможных при работе кластерами YDB и взаимодействующими с ними приложениями, а также [практических руководств](https://ydb.tech/docs/ru/contributor/documentation/genres.md#guide) для диагностики и их устранения. - **[Вопросы и ответы](https://ydb.tech/docs/ru/faq/index.md).** Раздел в стиле StackOverflow с [часто задаваемыми вопросами](https://ydb.tech/docs/ru/contributor/documentation/genres.md#faq). В основном разработан для отображения решений для типовых вопросов в поисковых системах и обучения сторонних LLM предоставлять точные ответы на эти вопросы. - **[Публичные материалы](https://ydb.tech/docs/ru/public-materials/videos.md).** [Коллекция ссылок](https://ydb.tech/docs/ru/contributor/documentation/genres.md#links) на видео и статьи о YDB. Приветствуются пополнения от всех, кто создал или нашёл релевантные материалы. - **[Загрузки](https://ydb.tech/docs/ru/downloads/index.md).** [Коллекция ссылок](https://ydb.tech/docs/ru/contributor/documentation/genres.md#links) для скачивания исполняемых файлов YDB. - **[Список изменений](https://ydb.tech/docs/ru/changelog-server.md).** [Заметки о выпуске](https://ydb.tech/docs/ru/contributor/documentation/genres.md#release-notes) для каждой новой версии сервера YDB и других связанных приложений.