[GitHub] [incubator-doris] blackfox1983 opened a new issue #3447: 关于使用文档的编写建议

[GitBox <gi...@apache.org>]

blackfox1983 opened a new issue #3447:
URL: https://github.com/apache/incubator-doris/issues/3447


   开门见山，直接说问题和感受：
   总体而言，当某一个feature我们在用的时候，看完文档后，多数情况下是有了解的意境。
   最后操作时，除了核心的建表、load数据这些基础操作，稍微复杂一点的就会疑问很多。
   
   举几个例子：
   1、稳定性保障体系。从kafka导入数据到doris。因为这个是一个实时的导入过程，从稳定性角度考虑，如果想实时知道导入的成功率、以及失败的sample…… 这块有没有api或者工具来对外输出。因为要做监控和报警。
   2、易用性。还是上面这个例子，比如我们要用从kafka导入，看了下多是理论上的操作，最好可以有一个实践的示例（比如就是一个真实的过程，涉及上传整数、连接kafka、检查效果……各个关键环节）。当然还有一些细节问题，文档和help都没法给出一个最终的端到端的手册，得看了文档再看help或者说看了help再看文档。
   3、困惑。最新的文档看了支持fe插件和be的udf，但是都是讲how，对于用户来说，很难理解这个功能到底可以帮助业务解决那些问题，以及什么时候用这个功能。期初的what和why其实希望可以补充下。或者说这个feature开发时遇到的业务问题描述下也可。这样可以帮助用户理解这块说明的背景，更好的理解这个feature的意义。
   
   如果在群里问不到，业务线自己调研其实挺费时间，还不一定符合预期，很多时候业务线就自己做了。长久以来，其实对于doris或者业务线，都没法形成一个双赢的生态。
   
   建议：
   辛苦doris的同学帮看看是否可行
   1、每一个feature最好有一个实践的过程。
   A、如果是面向操作的，直接有一个全局的操作报仇和图。至少包括准备、操作、结果检查几个。


----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@doris.apache.org
For additional commands, e-mail: commits-help@doris.apache.org

[GitHub] [incubator-doris] kangkaisen commented on issue #3447: 关于使用文档的编写建议

[GitBox <gi...@apache.org>]

kangkaisen commented on issue #3447:
URL: https://github.com/apache/incubator-doris/issues/3447#issuecomment-622348580


   @blackfox1983 很好的建议！
   我们最近也一直在完善文档，你的建议都比较合理。 我们会不断改进。 也期待和欢迎你帮助社区完善文档。 感谢。


----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@doris.apache.org
For additional commands, e-mail: commits-help@doris.apache.org