文档建议

新版文档在UI和分类上下了很大功夫,也丰富了一些解释说明和用例,非常感谢!

目前有两个建议望考虑:

1、文档目录的叶子页面,有很多篇幅较长,希望能添加一个子目录,这样可以快速了解整篇内容和定位

2、函数参考目录下的每一个函数介绍页,希望能首先介绍函数的用途,而不是只有语法、参数和注意事项,另外例子中最好也有些中文注释,方便用户理解场景和用法

官方文档是连接开发者和用户的最基本、最系统的桥梁,也直接影响着软件生态的健康和可持续成长,望重视

请先 登录 后评论

最佳答案 2024-01-18 16:20

您好,


关于第一个建议,我想您指的是文内的目录,比如显示在页面右侧的topic toc。如果指的是这样的目录,例如英文文档中的 https://docs.dolphindb.cn/en/Database/DatabaseandDistributedComputing/InMemoryComputing.html 页面


这样的目录其实中文部分在正式上线也有的。因为确实很多教程很长,而且在页面中也取消了gitee中常见的页首目录。但在测试中我们发现这样的页内TOC由于发布HTML的软件本身存在一个CJK(中日韩)文字符与拉丁字符共存时,或单纯CJK字符作为标题时,点击页内目录定位不准确的问题。比如说,点击2.2节标题在页内目录中的链接,可能不能精准定位到正文中2.2节标题后的第一句话,而是有一定的偏移,通常是一个段落或7行左右的偏移量。 该问题我们已经反馈给生成HTML的软件的开发商,经过复现后,他们也已经将该问题记录在他们的待解决问题列表中,会在该软件的下一个版本发布或补丁版本中解决。同时,为了避免有更多的用户使用不便,我们将中文部分的页内目录暂时隐藏。因此您看到的页面中只有左侧整体目录而无页内小目录。


关于第二个问题。 您所说的函数的用途一般是对应着函数页面的【详情】部分。这个问题在去年Q4中就已经有同事内部反馈,在我们的文档更新中,由于版本发布非常频繁,我们暂时只能在新函数或修改的函数页面中将详情部分提前,置于语法部分之后。关于示例脚本中的中文注释,您的建议非常中肯。我们会在后面的新文档中尽可能为关键语句加上中文注释,也会在时间允许的范围内对既有文档的示例进行注释补充。


非常感谢您的建议!


祝好,

Badr al-Din

请先 登录 后评论

其它 0 个回答

  • 1 关注
  • 0 收藏,260 浏览
  • 冰雪太阳 提出于 2024-01-17 18:29

相似问题