问题反馈
问题反馈
本页面将指导您如何有效地报告 DeepChat 中遇到的问题,提交功能请求,以及跟踪问题解决进度。有效的问题报告对于帮助开发团队理解、重现和解决问题至关重要。
问题反馈前的准备
检查已有问题
在提交新问题前,请先检查是否已有相同或类似的问题报告:
- 搜索 GitHub Issues 中的现有问题
- 查看 常见问题解答 页面
- 浏览 论坛 中的讨论
- 检查 故障排除 文档中是否有解决方案
收集必要信息
准备以下信息以帮助我们更快地理解和解决您的问题:
环境信息:
- DeepChat 版本号(在
设置 → 关于
中查看) - 操作系统和版本
- 浏览器类型和版本(如适用)
- 设备类型(桌面端/移动端)
- 安装方式(网页版/桌面应用/移动应用)
- DeepChat 版本号(在
问题信息:
- 明确、简洁的问题描述
- 问题的复现步骤
- 预期行为和实际行为的对比
- 问题的发生频率(总是/有时/偶尔)
- 问题何时开始出现(更新后/特定操作后)
辅助材料:
- 错误信息截图
- 应用日志(如有)
- 相关配置文件(注意移除敏感信息)
- 录屏演示(对于复杂或难以描述的问题)
提交问题报告
在 GitHub 上报告问题
GitHub Issues 是报告技术问题和功能请求的首选途径:
- 访问 DeepChat GitHub 仓库
- 点击 "New Issue" 按钮
- 选择适当的问题模板:
- Bug 报告
- 功能请求
- 文档问题
- 性能问题
- 安全问题(对于安全漏洞,请考虑使用私密报告途径)
- 填写模板中的所有必要信息
- 添加适当的标签以帮助分类
- 提交问题
Bug 报告示例
一个好的 Bug 报告示例:
标题:无法在对话中保存自定义提示词模板
环境信息:
- DeepChat 版本:2.4.2
- 操作系统:Windows 11
- 浏览器:Chrome 112.0.5615.138
- 安装类型:桌面应用
问题描述:
在对话中创建的自定义提示词模板无法保存。点击"保存模板"按钮后,提示保存成功,但刷新应用后模板消失。
复现步骤:
1. 打开任意对话
2. 点击右上角的"提示词"按钮
3. 选择"创建新模板"
4. 填写模板名称和内容
5. 点击"保存"
6. 关闭并重新打开应用
7. 检查保存的模板列表
预期行为:模板应该保存并在重启后仍然可用。
实际行为:保存提示显示成功,但重启后模板消失。
其他信息:
- 此问题在上周升级到 2.4.2 版本后开始出现
- 已尝试清除缓存和重新安装,问题依然存在
- 附件中包含错误日志和问题截图
功能请求示例
一个有效的功能请求示例:
标题:为对话历史添加批量导出功能
功能描述:
希望能够一次性导出多个选定的对话,而不必逐个导出。这对于备份或迁移大量对话非常有用。
使用场景:
1. 用户需要备份所有工作相关的对话
2. 在设备间迁移多个对话
3. 为团队共享一组相关对话
建议实现:
在对话列表页面添加多选功能,允许用户选择多个对话,然后通过"导出选定项"按钮将它们导出为单个文件或压缩包。
可选的导出格式:
- JSON(完整数据)
- Markdown(纯文本对话)
- PDF(格式化对话)
- ZIP(包含所有选定格式)
优先级:中等
在论坛中报告问题
对于需要社区讨论的问题或使用问题:
- 访问 DeepChat 论坛
- 在适当的板块创建新主题(如"技术支持"或"功能讨论")
- 提供与 GitHub Issues 相同的详细信息
- 使用描述性标题并添加相关标签
- 积极参与后续讨论
问题报告的类型
不同类型的问题报告需要不同的信息:
功能性 Bug
应用的特定功能不能正常工作:
- 明确指出哪个功能受影响
- 提供详细的复现步骤
- 描述预期行为和实际行为
- 包含任何相关错误消息
性能问题
应用响应缓慢或资源使用过高:
- 描述性能问题的确切症状(启动慢/响应延迟/内存使用高)
- 提供影响性能的具体操作
- 包含性能指标(如加载时间、内存使用量)
- 说明问题是何时开始出现的
用户界面问题
界面显示错误或交互问题:
- 提供问题的屏幕截图
- 说明您使用的设备屏幕尺寸和分辨率
- 描述视觉或交互问题的具体表现
- 提及问题是否在特定浏览器或设备上更明显
崩溃和稳定性问题
应用完全停止工作或意外关闭:
- 描述崩溃前进行的操作
- 提供崩溃日志(如有)
- 说明崩溃的频率和可预测性
- 提及是否能够通过特定操作可靠地触发崩溃
功能请求
建议添加新功能或改进现有功能:
- 清晰描述所需功能
- 解释功能将解决的问题或满足的需求
- 提供使用场景和潜在受益用户
- 如可能,提出实现该功能的建议方法
文档问题
文档中的错误、缺失或不清晰内容:
- 指明具体的文档页面和部分
- 描述问题(错误/遗漏/混淆)
- 提供改进建议或更正
安全漏洞报告
对于安全相关的问题,请遵循以下特殊流程:
- 不要公开披露:安全漏洞不应在公开的 Issue 或论坛中报告
- 私密报告:
- 发送电子邮件至 security@deepchat.thinkinai.xyz
- 或使用 GitHub 的私密安全漏洞报告功能
- 提供详情:包含漏洞的详细描述、影响范围和复现方法
- 负责任披露:给予开发团队足够时间修复问题后再公开讨论
问题跟踪流程
提交问题后的后续流程:
问题生命周期
了解问题处理的各个阶段:
- 已提交:问题已成功提交,等待初步审核
- 已分类:团队已审核并分类,可能会要求更多信息
- 已确认:问题已被开发团队确认
- 正在处理:开发者正在修复此问题
- 已解决:修复已完成并等待发布
- 已关闭:问题已修复并在发布版本中可用
提供额外信息
如果维护者要求提供更多信息:
- 及时回复并提供请求的详细信息
- 如果您无法复现问题,说明具体原因
- 如条件允许,测试维护者建议的临时解决方案
优先级和时间线
问题解决的优先级取决于多个因素:
- 严重性:影响程度和用户数量
- 紧急性:是否阻碍核心功能使用
- 复杂性:解决问题的技术难度
- 资源可用性:团队当前的工作负载
注意:虽然我们努力尽快解决所有问题,但时间框架可能因上述因素而异。
构建有效反馈的技巧
做什么
具体明确:提供具体细节,而不是泛泛而谈
- 好:"点击保存按钮后,对话历史不更新"
- 差:"保存功能不工作"
客观描述:陈述事实而非个人感受
- 好:"应用在导入大文件时冻结约 5 秒"
- 差:"应用导入文件时非常慢,令人沮丧"
包含上下文:提供问题的完整背景
- 好:"使用中文界面时,导出菜单选项显示不完整"
- 差:"部分界面文字显示不完整"
分步骤描述:清晰列出复现步骤
- 好:提供精确、有序的操作步骤
- 差:笼统描述或跳过关键步骤
避免什么
- 情绪化语言:保持专业和建设性
- 假设问题原因:除非您确定,否则只描述症状
- 不必要的紧急性:除非确实紧急,避免过度强调紧急性
- 过多未经筛选的信息:提供相关信息,避免信息过载
社区互助
帮助他人解决问题
如果您发现自己能解答其他用户的问题:
- 分享您的解决方案和经验
- 提供清晰的解释步骤
- 如适用,解释问题的根本原因
- 保持友好和支持性的态度
投票和确认问题
帮助开发团队了解问题的影响范围:
- 为您遇到的相同问题点赞或添加评论
- 提供您环境中的额外信息
- 确认您是否能够复现问题或使用提供的解决方法
问题讨论礼仪
参与问题讨论时:
- 尊重他人时间和观点
- 保持讨论与主题相关
- 避免重复已有信息
- 使用清晰的格式化文本增强可读性
常见问题
问:我的问题报告多久会得到回应? 答:通常我们会在 2-3 个工作日内进行初步回应。高严重性问题可能会更快获得响应。
问:如何判断我的问题是 Bug 还是功能请求? 答:如果是现有功能不按预期工作,则是 Bug;如果是建议添加应用当前没有的功能,则是功能请求。
问:我可以用中文报告问题吗? 答:可以。我们接受多语言的问题报告,包括中文。核心团队和社区成员会协助翻译。
问:我应该在 GitHub 还是论坛报告问题? 答:技术问题和明确的 Bug 报告优先使用 GitHub Issues;如需社区讨论或不确定是否为 Bug,可以先在论坛发帖。
问:我的问题已修复但未关闭,应该怎么做? 答:请在问题下评论,说明问题已解决,并提供解决它的版本号或方法。
通过遵循这些指南,您可以帮助开发团队更有效地解决问题,从而改进 DeepChat 的整体质量和用户体验。我们感谢您的反馈和参与!
这里应放置一张问题报告流程或界面的截图。