# QmClient 提问与反馈指南
遇到不会使用的功能、客户端异常，或者有改进建议，都可以提出。
清楚的描述能减少来回确认，让其他玩家和开发者更快理解问题。这份指南说明提问时应该提供什么，以及怎样把反馈写得方便排查。
不需要懂编程，也不需要提前找出原因。先把自己确认的信息写清楚，不知道的地方可以注明“不清楚”。
## 一、先把问题直接说出来
在群里提问时，可以直接发送问题和必要信息。
只有“在吗”“有人吗”“能问个问题吗”，其他人还无法判断能否帮上忙。尽量在第一条消息里说明：
- 使用的 QmClient 完整版本号。
- 操作系统。
- 做了什么操作。
- 实际出现了什么情况。
- 希望得到什么结果。
例如：
> 我使用的是 QmClient【完整版本号】，系统是 Windows 11。切换到全屏后，画面停在切换前的内容，声音仍然继续。重新启动可以恢复，但再次切换还会出现。想确认还需要提供哪些信息，录屏已附上。
本文中的故障场景均为写法示例，不代表当前版本的已知问题。
## 二、提问前，先做几项简单确认
### 看看是否已有说明或相同反馈
可以先查看：
- 相关功能的设置说明。
- 项目公告和更新说明。
- 群聊中的相关记录。
- GitHub Issues 中的相似问题。
搜索时，使用功能名称、报错原文和触发操作。例如：
- `全屏 黑屏`
- `聊天 输入法`
- `切换地图 崩溃`
- `某个设置项的名称`
找到相似反馈后，核对版本、触发条件和表现。表现相似的问题，原因也可能不同。
### 记下准确版本
“最新版”“昨天下载的”“朋友发给我的”都难以确定具体版本。
请填写客户端显示的完整版本号。正式版、预览版和自行编译的版本也请注明。
如果是自行编译，并且知道对应的提交 SHA，可以一起提供。
### 尝试简单、可恢复的排查
根据问题选择相关操作即可：
- 重新启动后是否仍然出现。
- 关闭刚开启的功能后是否恢复。
- 换一个服务器或地图后是否仍然出现。
- 同一操作是否可以再次触发。
每次尽量只改变一个条件，并记下结果。
修改配置前先备份。保留能够触发问题的配置，有助于后续排查。
这些操作不需要全部完成后才能反馈。偶发问题、无法再次复现的问题，也可以先记录当时的情况。
## 三、选择合适的反馈渠道
- **使用咨询**：可以在项目交流群等交流渠道直接提问，说明想完成的操作和卡住的位置。
- **BUG 反馈**：优先使用 GitHub 的 Bug 报告表单，便于保留步骤、附件和处理进度。
- **功能建议**：使用功能建议表单，说明使用场景和期望行为。
项目入口：
- [查看已有 Issues](https://github.com/wxj881027/QmClient/issues)
- [提交 Bug 报告](https://github.com/wxj881027/QmClient/issues/new?template=01-bug-report.yml)
- [提交功能建议](https://github.com/wxj881027/QmClient/issues/new?template=02-feature-request.yml)
同一个问题尽量集中在一个帖子里更新。如果已经有相同反馈，可以补充自己的版本、环境和复现结果。
“我也有”可以进一步写成：
> 我在【版本号】、【系统】下也能复现。按原帖步骤尝试了 3 次，出现了 2 次。补充录屏如下。
不同问题分别提交，方便讨论和确认解决情况。
## 四、怎样描述一个问题
### 标题写出触发条件和具体表现
“有 BUG”“不好用”“救命”“赶紧修”提供的信息有限。
可以写成：
- `[Bug] 切换全屏后画面停住，声音仍然继续`
- `[Bug] 调大界面缩放后，设置按钮文字被截断`
- `[Bug] 重新连接服务器后，之前修改的设置恢复原值`
标题不需要塞入全部细节，让人能看出发生了什么即可。
### 把预期结果和实际结果分开
例如：
- **预期结果**：关闭设置页面后，继续操作游戏。
- **实际结果**：设置页面消失，但鼠标点击仍然无法控制游戏。
“异常”“有问题”“不正常”可以作为概述，后面还需要说明具体表现。
### 按顺序写出复现步骤
别人应当能够照着步骤操作。
例如：
1. 启动客户端，进入一个服务器。
2. 打开设置页面。
3. 修改【具体设置项】。
4. 关闭设置页面。
5. 执行【具体操作】。
6. 出现【具体异常】。
如果需要提前开启某个功能、使用某种输入法，或者进入特定地图，请写在步骤前面。
偶发问题可以写明观察到的频率，例如“最近 5 次切换中出现了 2 次”。没有记录时，填写“偶发，频率不确定”即可。
### 区分观察结果和原因猜测
可以提出怀疑，同时保留事实依据。
例如：
> 开启某项特效后，我连续 3 次切换地图都出现了卡顿；关闭后尝试了 3 次，暂时没有出现。我怀疑与这个选项有关。
这样的信息能帮助缩小范围。仅凭时间上相邻，还不能确定是哪段代码导致了问题。
### 写清已经尝试的操作及结果
“全试过了”“网上的方法都没用”很难用于继续排查。
可以写成：
- 重新启动客户端：问题仍然出现。
- 关闭【设置项】：暂时恢复。
- 换到另一个服务器：仍然出现。
- 恢复原来的设置：问题再次出现。
暂时绕过问题的方法也有价值，请保留具体步骤。
## 五、不同问题需要哪些补充信息
按问题选择相关内容即可，不必提交所有设备和配置资料。
| 问题类型 | 建议补充的信息 |
| -------------------------------- | ---------------------------------------------------------------- |
| 界面错位、文字截断、显示异常 | 截图、分辨率、界面缩放、系统显示缩放、客户端语言 |
| 动画闪烁、短暂重叠、点击过程异常 | 能看清操作过程的录屏、触发动作、相关设置 |
| 客户端闪退 | 出现时间、退出前的操作、报错原文；如已生成，附相关日志或崩溃文件 |
| 客户端卡死 | 卡住前的操作、持续时间、是否自行恢复、声音和输入是否仍有反应 |
| 掉帧、卡顿 | 出现时的场景、相关画面设置、CPU 和显卡型号、帧率变化 |
| 延迟、连接失败、断线 | 服务器、发生时间、报错或断线提示、其他服务器是否也出现 |
| 输入法、按键、聊天输入异常 | 输入法名称、输入位置、触发按键、相关绑定、具体输入步骤 |
| 游戏内操作或表现异常 | 地图、服务器、当时的玩法状态；涉及分身、观战或练习时一并注明 |
“卡”可能对应多种表现。可以进一步说明：
- 画面帧率下降。
- 角色移动出现回拉。
- 按键后过一会儿才响应。
- 整个窗口停止刷新。
- 打开某个页面时短暂停顿。
## 六、怎样提供截图、录屏和日志
### 截图要能看出上下文
界面问题建议同时提供：
- 一张能看出页面位置的完整截图。
- 一张标明异常位置的局部截图。
描述对应位置，例如“右下角按钮的第二行文字被截断”，避免只发图片让别人寻找问题。
截图尽量使用系统截图功能，保证文字和细节清楚。
### 动态问题优先录屏
闪烁、动画残留、点击失效和短暂卡顿，通常更适合用录屏展示。
录屏尽量包含：
1. 问题出现前的状态。
2. 触发问题的操作。
3. 问题出现后的表现。
视频较长时，标明异常发生的时间点，例如“00:18 切换页面后出现”。
### 报错和日志尽量提供原始文本
报错可以复制时，保留完整原文，不要只写“弹了一个英文错误”。
较短的日志使用代码块：
```text
在这里粘贴相关报错或日志。
```
较长的日志作为附件上传，并说明问题发生的大致时间。
不清楚需要哪份日志或如何获取时，可以直接询问。
上传截图、日志和配置前，检查并遮住密码、授权码、令牌及私人聊天等内容。保留与问题有关的报错、时间和操作信息。
## 七、怎样提出功能建议
先说明使用场景，再描述希望增加的行为。
例如：
> 我经常在两套设置之间切换，每次都需要重新调整多个选项。希望能够保存并切换配置方案，减少重复操作。
如果已有具体想法，可以继续补充：
- 从哪里进入这个功能。
- 需要保存或切换哪些内容。
- 希望默认开启还是关闭。
- 关闭后希望恢复什么行为。
- 是否有可以参考的截图或操作过程。
这些内容可以帮助理解需求，不要求提建议的人提前完成设计。
参考其他客户端时，请指出具体功能和有用的部分。“照着某客户端做”仍然需要进一步确认范围。
功能建议会结合实际用途、维护成本和项目方向评估。提交建议后，可以继续补充场景和细节。
## 八、收到回复后，怎样继续沟通
### 补充被询问的信息
被要求提供版本、录屏或复现步骤时，尽量一次补齐。
暂时无法提供的内容，说明具体原因。操作步骤看不懂时，指出卡在哪一步，例如：
> 我找到了设置页面，但没有找到你提到的选项，能否说明它所在的分类？
### 尝试后反馈实际结果
可以写成：
> 已按建议关闭【设置项】，重新启动后尝试了 3 次，问题仍然出现。新的录屏中，异常发生在 00:12。
### 问题解决后，补充解决方式
建议记录：
- 使用哪个版本后恢复。
- 修改了哪个设置。
- 原来的复现步骤是否仍然触发。
- 是否还有相关异常。
如果通过关闭某个功能暂时恢复，请注明这是临时绕过办法。
### 暂时没有回复时
可以在原帖补充新的录屏、日志、复现条件或尝试结果。
避免反复发送相同内容、连续催促或同时联系多个维护者。新的事实更有助于推进排查。
## 九、给回答问题的人
提供帮助时，也尽量让对方知道下一步该做什么：
- 缺少信息时，明确指出需要补充的项目。
- 建议搜索时，给出关键词或相关链接。
- 要求操作时，说明具体入口和预期结果。
- 提出原因判断时，说明依据和仍待确认的部分。
- 对不熟悉的术语作简短解释。
## 十、可直接复制的反馈模板
### 群内简短提问
```text
问题：
QmClient 完整版本号：
操作系统：
触发操作：
实际表现：
希望的结果：
已尝试及结果：
截图 / 录屏：
```
### BUG 反馈
1. 问题概述
一句话说明遇到的异常。
2. 使用环境
- QmClient 完整版本号：
- 版本类型：正式版 / 预览版 / 自行编译
- 操作系统及版本：
- 下载来源：
- 与问题有关的设置或设备信息：
3. 复现步骤
- XXX
- XXX
- XXX
4. 预期结果
说明原本希望发生什么。
5. 实际结果
说明实际发生什么，保留报错原文。
6. 发生频率
每次出现 / 偶发 / 仅出现过一次。如果有记录，填写尝试次数和出现次数。
7. 已尝试的操作及结果
- 操作：
- 结果：
8. 截图、录屏或日志
上传相关附件。录屏较长时，标明异常时间点。
9. 其他线索
例如：从哪个版本开始出现，是否只在某个地图或服务器发生。
### 功能建议
1. 使用场景
我在什么情况下需要这个功能？
2. 当前遇到的问题
现有操作有哪些不便，影响了什么？
3. 希望增加的行为
希望客户端具体怎样工作？
4. 可选的实现建议
入口、交互方式、默认状态、关闭行为或参考示例,没有具体想法可以删除本节。
5. 补充材料
截图、录屏或其他相关说明。