ドキュメントの保守に関する説明
このドキュメントは、各アダプタ開発者が保守しており、OneBot12 標準との差異や拡張機能を説明するために使用されます。 アダプタ開発者は、新バージョンをリリースする際に、このドキュメントも同時に更新してください。
更新要件
- プラットフォーム固有の送信方法とパラメータを正確に記述すること
- OneBot12 標準との差異点を詳細に説明すること
- 明確なコード例とパラメータの説明を提供すること
- ドキュメントのフォーマットを統一し、ユーザーが見つけやすいようにすること
- バージョン情報とメンテナの連絡先をタイムリーに更新すること
ドキュメント構造規格
1. 基本情報部分
各プラットフォーム機能ドキュメントには、以下の基本情報が含まれている必要があります。
# プラットフォーム名アダプタドキュメント
アダプタ名: [アダプタクラス名]
プラットフォーム紹介: [プラットフォームの簡単な紹介]
サポートするプロトコル/APIバージョン: [具体的なプロトコルまたはAPIバージョン]
メンテナ: [メンテナの氏名/チーム名]
対応モジュールバージョン: [バージョン番号]
2. 支持するメッセージ送信タイプ
すべてのサポートする送信メソッドとそのパラメータを詳細に記述します。
## 支持するメッセージ送信タイプ
すべての送信メソッドは、メソッドチェーン構文で実現されます。たとえば:
[コード例]
サポートする送信タイプは以下の通りです。
- メソッド1: 説明
- メソッド2: 説明
- ...
### パラメータの説明
| パラメータ | 型 | 説明 |
|------|------|------|
| パラメータ名 | 型 | 説明 |
3. 特有のイベントタイプ
プラットフォーム固有のイベントタイプとその形式を詳細に説明します。
## 特有のイベントタイプ
[プラットフォーム名]のイベントはOneBot12プロトコルに変換され、標準フィールドはOneBot12プロトコルに完全に準拠しますが、以下の違いがあります。
### 核心的な違い
1. 特有のイベントタイプ:
- イベントタイプ1: 説明
- イベントタイプ2: 説明
2. 拡張フィールド:
- フィールドの説明
### 特殊フィールドの例
[JSON例]
4. 拡張フィールドの説明
## 拡張フィールドの説明
- すべての固有フィールドは、`[platform]_` という接頭辞で識別されます
- 元のデータは、`[platform]_raw` フィールドに保持されます
- [その他の特殊フィールドの説明]
5. 設定オプション（該当する場合）
## 設定オプション
[プラットフォーム名]アダプタは以下の設定オプションをサポートします。
### 基本設定
- 設定項目1: 説明
- 設定項目2: 説明
### 特殊設定
- 特殊設定項目1: 説明
内容作成規格
コード例の規格
- すべてのコード例は実行可能な完全な例でなければなりません。
- 標準的なインポート方法を使用してください：
from ErisPulse.Core import adapter
[アダプタのインスタンス] = adapter.get("[アダプタ名]")
- 複数の使用シナリオの例を提供してください。
ドキュメント形式の規格
- 標準的なMarkdown形式を使用してください。
- タイトルの階層が明確で、最大4段階のタイトルを使用してください。
- テーブルは標準的なMarkdownテーブル形式を使用してください。
- コードブロックには適切な言語識別子を使用してください。
バージョン更新の説明
ドキュメントを更新するたびに、ドキュメントの最上部にバージョン情報を更新してください：
## ドキュメント情報
- 対応モジュールバージョン: [新しいバージョン番号]
- メンテナー: [メンテナー情報]
- 最終更新日: [日付]
質量チェックリスト
ドキュメントの更新を提出する前に、以下の内容を確認してください：
- ドキュメントの構造が規格要件に準拠している
- すべてのコード例が正常に実行できる
- パラメータの説明が完全かつ正確である
- イベント形式の例が実際の出力に合致している
- リンクと引用が正しく無誤である
- 文法とスペルに誤りがない
- バージョン情報が更新されている
- メンテナー情報が正確である
参考文書
一貫性を確保するために、以下の文書を参考にしてください：
貢献フロー
- ErisPulse リポジトリを Fork する
docs/platform-features/ディレクトリ内で対応するプラットフォームのドキュメントを変更する- ドキュメントが上記の規格要件に準拠していることを確認する
- Pull Request を送信し、変更内容を詳しく説明する
ご質問がある場合は、関連するアダプタのメンテナに連絡するか、プロジェクトの Issues で質問してください。