> ## Documentation Index
> Fetch the complete documentation index at: https://docs.ss14.art/llms.txt
> Use this file to discover all available pages before exploring further.

# Документация — для поиска решений

Этот документ призван прояснить **чрезвычайно важный момент** в написании документации, который должны усвоить все, кто хочет добавлять новые страницы.

***Документация — для поиска решений!***

Это означает, что документация для систем *не* должна включать:

* Конкретные API методов, которые могут измениться
* Перечисление и описание каждого поля случайного prototype
* Объяснение деталей кода, которые в 100 раз лучше передаются через комментарии в коде и xmldocs

Когда кто-то ищет «документацию» по теме, на самом деле он может искать две разные вещи. У него может быть лишь общее представление о том, что он хочет сделать, и он ищет *как* — какие *инструменты и системы вообще доступны* и как они сочетаются друг с другом. Это именно та услуга, которую предоставляет сайт markdown-документации, подобный этому.

Или же он может искать *что* — конкретные API, с которыми работает, какие методы можно вызывать, что передавать в эти методы, переопределения абстрактных методов и т.д. Для этого лучше всего подходит *ваша IDE*, потому что C# — статически типизированный язык, и эта информация легко доступна любому программисту. Поиск по файлам также *очень* эффективен, когда ваша IDE не может помочь (например, при поиске доступных полей YAML).

<Note>
  Хорошо:
</Note>

```
Если вы пытаетесь сделать X, лучший способ — через GlubbySystem...
...
Сначала создайте GlubbyPrototype в YAML, затем в вашей системе вызывайте методы GlubbySystem
для создания и регистрации glubber...
```

Плохо:

```
Вот поля, доступные в GlubbyPrototype:
glubPotency: это целочисленное поле
glubDecay: это поле типа timespan
glubberDelay: это поле типа timespan
glubTargets: это поле типа словарь string->entityuid цели glub
```

Нет гарантии, что все страницы документации будут соответствовать этой концепции! Многие из них очень, очень старые. Если вы хотите их переписать, [вперёд!](./guide-to-editing-docs)

## SEO-оптимизация

Чтобы ваша страница была хорошо находилась как через поиск по сайту, так и через внешние поисковики (Google, Yandex), следуйте этим принципам:

### Заголовки и описания

Каждая страница должна иметь уникальные `title` и `description` во frontmatter:

```yaml theme={null}
---
title: "Создание первой карты"
description: "Пошаговое руководство по созданию вашей первой карты для Space Station 14"
---
```

* `title` — 50-60 символов, содержит ключевые слова
* `description` — 150-160 символов, краткое и точное описание

### Структура контента

* Используйте правильную иерархию заголовков (H2 → H3 → H4)
* Не пропускайте уровни (не переходите с H2 на H4)
* Пишите для людей в первую очередь, для поисковиков — во вторую

### Внутренние ссылки

* Ссылайтесь на связанные страницы внутри документации
* Используйте описательный текст ссылки вместо «нажми сюда»
* Группируйте связанные концепции ссылками друг на друга

### Ключевые слова

Используйте релевантные ключевые слова в заголовках и тексте, но органично — не набивайте ими текст.

## Поиск по сайту

Mintlify автоматически индексирует все страницы, добавленные в навигацию `docs.json`.

### Повышение приоритета

Чтобы страница находилась выше в результатах поиска, добавьте `boost` во frontmatter:

```yaml theme={null}
---
title: "Создание первой карты"
boost: 3
---
```

Значение по умолчанию — `1.0`. Чем выше число, тем приоритетнее страница. Можно деприоритизировать устаревшие страницы значением `0.25`.

### Скрытие от поиска

Чтобы скрыть страницу и из поиска по сайту, и из поисковиков:

```yaml theme={null}
---
noindex: true
---
```

Страницы с `hidden: true` автоматически получают `noindex: true`.

## Мета-теги

Mintlify генерирует базовые meta-теги автоматически. Для переопределения на конкретной странице укажите их во frontmatter:

```yaml theme={null}
---
title: "Создание первой карты"
description: "Пошаговое руководство"
"og:title": "SS14: Создание карты"
"og:image": "https://docs.ss14.art/images/map-preview.png"
keywords: ["карта", "SS14", "mapping", "руководство"]
---
```

## AI-доступность

Mintlify включает директивы Content-Signal, которые разрешают AI-инструментам (ChatGPT, Claude, Perplexity) индексировать и цитировать документацию. Это помогает разработчикам получать ответы через AI-ассистентов.

Если вам нужно заблокировать AI-краулеров, создайте файл `robots.txt` в корне проекта.