欢迎大家来到 Taichi 论坛,目前论坛中的帖子较多,请在发帖提问之前阅读本帖,为解决问题的社区成员提供便利,感谢大家~
正确的提问方式
提问之前
请先尝试在网络上搜索答案,包括但不仅限于:
-
Taichi 官网文档;Taichi 的文档汇聚了研发和技术写作同学大量的心血,内容充实结构清晰,在提问前请确保搜索过文档~
-
在本论坛或 GitHub 中搜索答案;Taichi 中文论坛和 GitHub 沉淀了很多有价值的问题和回答,动手搜索一下有惊喜哦~
-
常用搜索引擎 如 Google、baidu、Bing
-
尝试阅读常见问题文件(FAQ)以找到答案;目前 Taichi 的 FAQ 在文档站中,搜索文档时也会一并列出
提问时
请先表明你已经做了上述的努力;这将有助于树立你并不是一个不劳而获且浪费别人的时间的提问者。在社区里提问或者发起相关技术话题讨论是被鼓励的,但是提问也是一门艺术,需要提问者好好把握。
-
在正确地方提问
- 如果你的问题涉及到使用或者运行报错,请在本论坛或 GitHub 提问。使用或报错的问题经常需要反复沟通,微信群不适合追踪这类问题。
-
明确的标题和分类
- 准确描述标题便于搜索和回答,正确的标签可以提高阅读问题的效率。
-
请按照主题模板尽可能详细、清晰、正确、精简地描述你的问题。
- 无效的问题,往往浪费大家的时间去阅读和理解,并且可能没有人去给你解答。
-
提问时要有一定的礼貌,尤其通过社区向个人提问时至关重要。
-
别人没有义务一定要给你解决问题,尤其当该问题需要花费不少时间去梳理和解答。
-
应该礼貌地请教问题,不管问题最终是否得到解答,都能够表示感谢。客气一点肯定会增加你得到有用回应的机会。
-
提问时把关键信息都列清楚,给解答问题的同学提供便利是美德~
-
代码相关的问题,不要超过 100 行,太长的代码很难定位问题
-
-
提问后
如果有人解答了你的问题,请将其的答案选择为「最佳答案」。最佳答案不仅仅是对回答者的肯定,也便于内容沉淀,有同样问题的同学可以更容易搜索到回答内容。
提问模板
在 Taichi 社区的中文论坛上提问时,请遵循以下提问准则,以便其他社区成员更容易理解您的问题并提供帮助。
- 选择一个清晰、简洁的标题
标题应简短地概括您的问题。避免使用模糊或过于宽泛的词语。一个好的标题可以让其他社区成员迅速了解您的问题,并决定是否能够提供帮助。
- 描述问题
在正文中,详细描述您遇到的问题。提供以下信息:
-
您试图实现什么功能?
-
您遇到了什么问题?请尽可能详细地描述错误信息和异常情况。
-
您已经尝试了哪些解决方案?这有助于避免其他人重复提供相同的建议。
- 提供代码示例
如果可能的话,提供一段可以重现问题的简短代码示例。确保代码清晰易懂,删除不相关的部分。使用代码块格式化您的代码,以便其他人更容易阅读。
请注意社区是一个开放的平台,任何交流都应该公开,代码也请贴在帖子内便于社区同学搜索
- 提供环境信息
提供有关您的开发环境的信息,包括:
-
操作系统
-
Python 版本
-
Taichi 版本
-
其他相关软件包和库的版本
这些信息有助于其他社区成员判断问题是否与特定环境相关。
- 使用标签
使用论坛的标签功能为您的问题添加合适的标签。这可以帮助其他社区成员更容易地找到和分类问题。
遵循这些准则,您将能够更清晰地提出问题,并使其他 Taichi 社区成员更容易帮助您。同时,这也有助于维护一个积极、友好的社区氛围。