文档维护说明
此文档由各适配器开发者维护,用于说明该适配器与 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 中提问。