文件維護說明
此文件由各適配器開發者維護,用於說明該適配器與 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 表格格式
- 程式碼區塊使用適當的語言標識
版本更新說明
每次更新文件時,應在文件頂部更新版本資訊:
## 文件資訊
- 對應模組版本: [新版本號]
- 維護者: [維護者資訊]
- 最後更新: [日期]
質量檢查清單
在提交文件更新之前,請檢查以下內容:
- 文件結構符合規範要求
- 所有程式碼範例可以正常執行
- 參數說明完整且準確
- 事件格式範例符合實際輸出
- 鏈接和引用正確無誤
- 語法和拼字無錯誤
- 版本資訊已更新
- 維護者資訊準確
參考文件
撰寫時請參考以下文件以確保一致性:
貢獻流程
- Fork ErisPulse 倉庫
- 在
docs/platform-features/目錄下修改對應的平台文件 - 確保文件符合上述規範要求
- 提交 Pull Request 並詳細說明修改內容
如有疑問,請聯繫相關適配器維護者或在項目 Issues 中提問。