--- metadata: - name: generator content: Diplodoc Platform v5.52.0 alternate: - https://ydb.tech/docs/en/contributor/documentation/genres.md?version=v25.3 - https://ydb.tech/docs/ru/contributor/documentation/genres.md?version=v25.3 - href: ru/contributor/documentation/genres.md type: text/markdown title: Markdown version - href: ../../llms.txt type: text/markdown title: llms.txt sourcePath: ru/core/contributor/documentation/genres.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?version=v25.3), описывая основные жанры статей, используемые в документации YDB. Понимание этих жанров помогает контрибьюторам размещать новый контент в соответствующем разделе и поддерживать консистентную структуру материалов. ## Теория {#theory} **Основная цель для читателя:** построить прочный фундамент знаний и прийти к пониманию основных концепций, архитектуры и принципов, на которых работает YDB. Теоретическая документация: - вводит ключевые концепции и терминологию; - объясняет, как система работает как с точки зрения пользователя, так и изнутри; - предоставляет высокоуровневые обзоры компонентов системы; - помогает пользователям понять «почему» за архитектурными решениями; - может быть нацелен либо на широкую аудиторию с минимальными предварительными знаниями, либо на конкретную роль; - может включать диаграммы и другие визуализации для помощи в передаче информации. Теоретическая документация в основном находится в разделе [Концепции YDB](https://ydb.tech/docs/ru/concepts/index.md?version=v25.3), но также появляется и в папках, специфичных для ролей, когда теоретическая информация релевантна только для конкретной аудитории. ## Руководство {#guide} **Основная цель для читателя:** выполнить конкретную практическую задачу или реализовать определённое решение с помощью YDB, следуя инструкциям. Руководства — это практические пошаговые инструкции, которые помогают пользователям достичь конкретной цели с помощью YDB. Каждая статья в этом жанре: - предоставляет чёткую цель и последовательные инструкции для её достижения; - включает конкретные примеры и команды; - фокусируется на практической реализации; - освещает конкретные сценарии использования; - может включать скриншоты для иллюстрации шагов. Руководства в основном находятся в папках, специфичных для ролей, таких как [YDB для DevOps-инженеров](https://ydb.tech/docs/ru/devops/index.md?version=v25.3), [YDB для разработчиков приложений](https://ydb.tech/docs/ru/dev/index.md?version=v25.3) и [YDB для инженеров по безопасности](https://ydb.tech/docs/ru/security/index.md?version=v25.3), а также в разделе [Диагностика проблем](https://ydb.tech/docs/ru/troubleshooting/index.md?version=v25.3). ## Справочник {#reference} **Основная цель для читателя:** найти дополнительную информацию по конкретной узкой теме, связанной с YDB. Справочная документация предоставляет всестороннюю, подробную информацию о компонентах YDB, запросах, API, параметрах конфигурации, CLI-командах, страницах UI и многом другом. Этот жанр: - стремится к полноте и точности; - служит ресурсом для поиска конкретных деталей; - документирует все доступные опции, параметры и настройки; - организован для быстрого поиска информации через поисковую систему или [LLM](https://ru.wikipedia.org/wiki/Большая_языковая_модель); - включает синтаксис, типы данных, параметры, возвращаемые значения, значения по умолчанию, конфигурацию и примеры. Справочная документация разработана для поиска по мере необходимости и является самым подробным уровнем документации. Она особенно полезна, когда пользователям нужна конкретная информация о функциях, настройках или ключевых словах. Этот контент в основном находится в разделе [Справка по YDB](https://ydb.tech/docs/ru/reference/index.md?version=v25.3). ## FAQ {#faq} **Основная цель для читателя:** быстро найти ответы на распространённые вопросы, возникающие при работе с YDB. Документация часто задаваемых вопросов (FAQ) отвечает на общие вопросы о YDB в формате прямых вопросов и ответов на них. Этот жанр: - обращается к конкретным, часто задаваемым вопросам; - предоставляет краткие, сфокусированные ответы; - организован по темам или категориям; - помогает пользователям быстро находить решения типовых проблем; - оптимизирован для обнаружения поисковыми системами или LLM. Контент FAQ в основном находится в разделе [Вопросы и ответы про YDB](https://ydb.tech/docs/ru/faq/index.md?version=v25.3) и разработан для помощи пользователям, которые ищут конкретные решения для типовых ситуаций. ## Рецепт {#recipe} **Основная цель для читателя:** реализовать конкретное, сфокусированное решение для типовой проблемы или сценария использования с помощью YDB. Рецепты — это короткие, сфокусированные мини-руководства, которые демонстрируют, как выполнять конкретные задачи с помощью YDB. Этот жанр: - предоставляет краткие решения для конкретных проблем; - включает фрагменты кода и примеры; - акцентирует внимание на практической реализации; - более узко сфокусирован, чем полноценные [руководства](#guide); - часто следует формату проблема-решение. Рецепты в основном находятся в разделе [Рецепты по работе с YDB](https://ydb.tech/docs/ru/recipes/index.md?version=v25.3), хотя похожий контент может также появляться в папках, специфичных для роли. ## Заметки о выпуске {#release-notes} **Основная цель для читателя:** быть в курсе новых функций, улучшений, исправлений ошибок и критических изменений в выпусках YDB. Заметки о выпуске документируют изменения, улучшения и исправления в каждой новой версии YDB. Этот жанр: - перечисляет новые функции и улучшения; - документирует исправления ошибок и решённые проблемы; - выделяет критические изменения и устаревшие функции; - предоставляет инструкции по обновлению при необходимости; - организован хронологически по номеру версии. Заметки о выпуске находятся в разделе [Список изменений YDB Server](https://ydb.tech/docs/ru/changelog-server.md?version=v25.3) и помогают пользователям понять, что изменилось между версиями, и решить, обновляться ли. ## Коллекция ссылок {#links} **Основная цель для читателя:** открыть для себя дополнительные ресурсы, учебные материалы и внешний контент, связанный с YDB. Коллекции ссылок предоставляют курированные списки ресурсов, связанных с YDB. Этот жанр: - агрегирует релевантные сторонние или внутренние ресурсы; - предоставляет краткие описания каждого связанного ресурса; - может быть организован по темам, форматам или степени релевантности; - помогает пользователям открывать для себя дополнительные учебные материалы; - может включать видео, статьи, загрузки и другой контент. Коллекции ссылок в основном находятся в разделах [Видеозаписи](https://ydb.tech/docs/ru/public-materials/videos.md?version=v25.3) и [Загрузки YDB](https://ydb.tech/docs/ru/downloads/index.md?version=v25.3) и выступают входными точками к внешним ресурсам о YDB.