对于一个菜鸟而言,leancloud的使用在掌握基础后,是方便且快捷的。但是,在掌握使用基础的过程中所遇到的文档,其写作水平确实有提高的空间。我这里给各位提一些建议,以作参考。我通过我使用云函数的过程,来呈现leancloud文档在我的视角中的样子,并提出一些意见。
前情提要:我正在使用leancloud来做一个toB 的管理系统,希望管理员账户可以禁止一些用户登录的,在论坛上询问被告知使用hook 来做这个功能,然后,随着hook查询到了云函数这个东西。
然后,我开始看云函数的文档《云函数开发指南 · Node.js》,其中:
文档中有一句内容:“如果还不知道如何创建云引擎项目、本地调试并部署到云端,请阅读《云引擎快速入门》。”
而在文档中,当前页面里的标题 “云函数开发指南 · Node.js" 和文档内容中的“Hook函数”都增加了链接,并连接到了本文档,而最有可能需要外链的《云引擎快速入门》却没有外链。
,在我需要去看《云引擎快速入门》的时候,必然要去上级目录去寻找,这时就会出现如下情况:
- 去查看上级目录JavaScript——因为位置排布和关联性原因,第一时间找到的上级目录就是上级目录JavaScript
- 当前的文档标题是《云函数开发指南.Node.js》,并且文档中说明“你可以使用云引擎的云函数”,那么,在我对leancloud了解的不够多的时候,自然会有一种理解,云引擎的使用文档,是不是也会有《云引擎快速入门.Node.js》呢?
- 现在打开JavaScript上级目录,发现没有《云引擎快速入门.Node.js》,甚至也没有《云函数开发指南.Node.js》,只有《云函数开发指南》,我就只有再次点开《云函数开发指南》后,才确认《云函数开发指南》就是《云引擎快速入门.Node.js》,并确认《云引擎快速入门》,并不在JavaScript目录中。
- 看完JavaScript目录后,找到云引擎目录,然后进入《云引擎快速入门》,噩梦再次开始:
- “请根据《命令行工具使用指南》的《安装命令行工具》一节安装最新版的命令行工具,并确保你已经在本地机器上可以成功运行命令行工具”:《命令行工具使用指南》与《安装命令行工具》再次没有超级链接,而且根据语义,完全不知道这两个东西可能的上级目录在哪里?
- 一通找下来,在《云引擎》目录下面,有一个《命令行工具 CLI 使用指南》的。这个看起来似乎就是,但是不确定。点开《命令行工具 CLI 使用指南》后,才发现 《命令行工具 CLI 使用指南》就是 《命令行工具使用指南》。
- 然后,《命令行工具使用指南》或者说是《命令行工具 CLI 使用指南》,开始做后续操作,不出意外,后续就开始处理 brew 的国内网速慢,要替换国内源等问题。
我们再次回到《云引擎快速入门.Node.js》当中,文档中列举的第一个用例是一个 AV.Cloud.define 的用例。
- 我们再次回到《云引擎快速入门.Node.js》当中,文档中列举的第一个用例是一个 AV.Cloud.define 的用例
- 我偶然在控制台乱点的时候,在控制台《云引擎》=>《WEB》=>《部署》页面,发现《创建函数》这个选项,然后进而发现,云函数可以直接通过在控制台进行定义。而这个路径,顺着贵司提供的文档,我其实很难找到。我不知道这是由于文档没有跟着产品更新还是怎么一回事,反正云函数 本来一个十分简短的使用路径,按照贵司文档指引的路径来看的话,不但岔路多,而且路途遥远。
所以,仅就一个简简单单的云函数用例的使用,贵司的文档本身就对我造成了很大的误导。我承认我是一个水平不那么高的程序员(本职产品经理,半路写程序的),但是,贵司的目的既然是希望更多的开发者来使用贵司的产品,就应该认识到,越是想要更多的人使用贵司的产品,贵司面对的开发者越是形形色色。
而贵司的产品使用说明书,也就是文档,不但没有降低开发者的使用门槛,还因为编写的随意,在不知不觉中增加开发者的使用门槛甚至误导开发者。
我强烈建议贵司还是想办法好好再整理一下文档,现在的文档读起来,真的难受。在整理文档的时候,还请贵司注意几点:
1,要对文档中的相关条目增加超链接,避免查看其他相关文档时,还要去主目录找的问题。
2,确保文档标题和目录标题一致,目录标题和文章标题一致,是写文章写文档的基本素养,这里贵司文档写的之随意,令人费解。
3,增加文档路由导航,例如《云函数开发指南 · Node.js》文档当中,应该有标识 JavaScrtipt/云函数开发指南 · Node.js,让用户不要迷路。这里可以猜测,因为缺乏导航表示,贵司为了区分js的《云函数开发指南》和其他语言的《云函数开发指南》,才在文档标题中写了《云函数开发指南.Node.js》,但是,又想在主目录中避免重复,又在JavaScript的主目录中,把《云函数开发指南.Node.js》写成了《云函数开发指南》。
4,及时更新说明,在云函数的用例使用中,从网页控制台中编辑云函数然后在线部署的云函数使用路径,在现有文档中,很难体现出来,这是不是可以理解为,文档没有做及时更新?
贵司文档,问题还是有很多,我仅就云函数的使用感官提一些小建议,供贵司参考。