Инструкция по поддержке документации

Данный документ поддерживается разработчиками адаптеров и предназначен для описания отличий и расширений, связанных с адаптером и стандартом OneBot12.
Разработчики адаптеров должны обновлять этот документ при выпуске новых версий.

Требования к обновлению

1. Точно описывайте специфичные для платформы методы отправки и параметры
2. Подробно объясняйте отличия от стандарта OneBot12
3. Предоставляйте понятные примеры кода и пояснения к параметрам
4. Сохраняйте единый формат документации для удобства пользователей
5. Вовремя обновляйте информацию о версии и контактные данные поддержки

Структура документации

1. Базовая информация

Документация для каждой платформы должна содержать следующую базовую информацию:

# Документация адаптера для платформы [Название платформы]

Название адаптера: [Имя класса адаптера]
Краткое описание платформы: [Краткое описание платформы]
Поддерживаемые протоколы/API версии: [Конкретные протоколы или версии API]
Разработчик: [Имя/команда разработчика]
Соответствующая версия модуля: [Номер версии]

2. Поддерживаемые типы отправки сообщений

Подробно перечислите все поддерживаемые методы отправки и их параметры:

## Поддерживаемые типы отправки сообщений

Все методы отправки реализованы с использованием цепочечного синтаксиса, например:
[Пример кода]

Поддерживаемые типы отправки включают:
- Метод 1: описание
- Метод 2: описание
- ...

### Описание параметров
| Параметр | Тип | Описание |
|----------|------|----------|
| Имя параметра | Тип | Описание |

3. Уникальные типы событий

Подробно опишите уникальные типы событий платформы и их формат:

## Уникальные типы событий

События платформы [Название платформы] преобразуются в протокол OneBot12, где стандартные поля полностью соответствуют протоколу OneBot12, но существуют следующие различия:

### Основные различия
1. Уникальные типы событий:
   - Тип события 1: описание
   - Тип события 2: описание
2. Расширенные поля:
   - Описание поля

### Примеры специальных полей
[Пример JSON]

4. Описание расширенных полей

## Описание расширенных полей

- Все уникальные поля идентифицируются с префиксом `[platform]_`
- Исходные данные сохраняются в поле `[platform]_raw`
- [Другие специальные поля]

5. Параметры конфигурации (при необходимости)

## Параметры конфигурации

Адаптер [Название платформы] поддерживает следующие параметры конфигурации:

### Базовая конфигурация
- Параметр 1: описание
- Параметр 2: описание

### Специальная конфигурация
- Специальный параметр 1: описание

Стандарты написания контента

Стандарты примеров кода

1. Все примеры кода должны быть полными и выполнимыми
2. Используйте стандартный способ импорта:

from ErisPulse.Core import adapter
[Экземпляр адаптера] = adapter.get("[Название адаптера]")

3. Предоставьте примеры использования в различных сценариях

Стандарты формата документации

1. Используйте стандартный синтаксис Markdown
2. Ясная иерархия заголовков, максимум 4 уровня заголовков
3. Используйте стандартный формат таблиц Markdown
4. Используйте соответствующие языковые идентификаторы для блоков кода

Информация об обновлении версии

При каждом обновлении документации обновите информацию о версии в начале документа:

## Информация о документации

- Версия соответствующего модуля: [Новая версия]
- Ответственный: [Информация о ответственном]
- Последнее обновление: [Дата]

Контрольный список качества

Перед отправкой обновлений документации проверьте следующие пункты:

• Структура документации соответствует требованиям
• Все примеры кода могут быть успешно выполнены
• Описание параметров полное и точное
• Примеры формата событий соответствуют фактическому выводу
• Ссылки и ссылки без ошибок
• Отсутствуют ошибки в синтаксисе и орфографии
• Информация о версии обновлена
• Информация о владельце документации точна

Справочная документация

При написании документации, пожалуйста, обращайтесь к следующим материалам для обеспечения согласованности:

• Официальный стандарт OneBot12
• Основные концепции ErisPulse
• Стандарт преобразования событий
• Спецификация ответов API
• Документация адаптеров для других платформ

Процесс внесения вклада

1. Создайте форк репозитория ErisPulse
2. Внесите изменения в соответствующий документ платформы в каталоге docs/platform-features/
3. Убедитесь, что документ соответствует вышеуказанным требованиям к формату
4. Создайте Pull Request и подробно опишите внесённые изменения

Если у вас возникнут вопросы, обратитесь к соответствующему адаптеру или задайте их в разделе Issues проекта.