如何有效的反馈问题

在之前 Github 和微信的问题反馈交流中, 我们经常发现由于提交的信息较少,导致了问题反馈沟通效率底下。 因此, Zadig 团队总结了一些可以提高沟通效率

  • 善用问题诊断手册, 一些常见问题的解决方案都在里面。

  • 请清晰的描述遇到的问题。

    • 错误示范: “我的系统出BUG了”

    • 正确示范: “我的XXX功能出现了YYYY问题, 具体表现为ZZZZZZ(附上错误截图)”

  • 请提供尽可能多的日志

    • 如果担心日志中含有敏感信息,可以将敏感信息马赛克/脱敏后提供日志
  • 如果文字不方便描述,使用截图来描述你碰到的问题

  • 我们为每个版本设置了专门的标签,在反馈问题的时候,强烈推荐带上版本的标签来提问

常用 Tips

  1. 如果碰上使用问题, 可以从以下几个地方获取信息:
    a. 打开浏览器的控制台,分别在 console 和 network 两栏中寻找是否有错误提示, 另外可以在console中看到版本信息。
    b. 常见问题都可以在 aslan 的 pod 中找到错误信息,使用以下命令可以获取日志信息,找到错误并截图带上他
kubectl logs pods/<aslan的pod> -n <zadig安装所在ns> -c aslan -f 
  1. 尽量提供完整的信息
    a. 如果以截图形式提供信息,请尽可能将整个页面截屏出来,而不是只提供出问题的那一个小模块
    b. 尽可能多的提供日志, 你看到的 error 级别日志不一定是导致你问题的日志!
5 个赞