我是小白菜鸟一名,所以对文档需求很是强烈的。
但是阅读来去,云里雾里的。
总结一下:1、文档要不是写给资深猿读的;2、要不就是高级猿写的文档。
我想,文档不是应该写给小白读的吗?
因为资深猿本来码的能力就够了,也深入了解原理,从另外的框架到DCLOUD或者学习新框架,因为很容易入手,也不用深入阅读文档了,那做文档来做什么?
所以文档本就是面向小白的,给老司机写文档也是表示表示诚意。
所以,如果文档不能写给小白看,那是得力不讨好的事情。
而且,最重要的是:好的文档才能更好的普及DCloud。
例如:5+SDK的文档:我们可以先不介绍5+SDK是什么,但是怎么使用?
一般SDK是放在项目一个文件夹里,然后使用接口调用,但是5+SDK的文档里没有。也许老司机明白,但是小白不懂啊。使用逻辑在哪里?
在后面“APP教程”文档说,HBuilder内置了,所以直接可以使用,但是5+SDK不就是给已有项目使用的吗?那么在一个项目里,5+SDK放在哪里?怎么放,怎么拿接口?怎么集成?怎么配置?——这些文档里面都有,但是文档编写的逻辑实在是好深好深啊——到底是先做什么?然后做什么?
我阅读了5+SDK文档还不是很明白,基于我的基础知识很是薄弱,真正小白一名,但是我尝试一下重新整理一下文档的逻辑结构,请老司机看看是否对不对。不过,有一个更重要的是:逻辑结构相对文档撰写来说,文档撰写要求更高,需要十分了解内在——对于这个我无能为力举例。
1、HTML5+SDK是什么?——只需要介绍是什么,暂时不介绍用途与目标之类。
(1)、介绍SDK
(2)、HTML5+SDK怎么来的?里面包含什么?——可以连接到HTML5+规范
(3)、SDK怎么在开发项目里起作用?简单说明集成原理。
(4)、SDK怎么在APP完成品里起作用?简单说明打包原理,SDK怎么打包在APP里。
2、怎样集成HTML5+SDK?
(1)、什么是WebView集成?什么是Widget集成?什么是独立应用方式集成?集成的实现原理与逻辑是什么?
(2)、Android平台5+SDK集成——需要更为小白逻辑的文档撰写
(3)、iOS平台5+SDK集成——需要更为小白逻辑的文档撰写
3、怎样使用HTML5+SDK?
举一些通用的例子在项目里使用SDK
4、打包(读不懂所以只能复制了)
(1)、IOS平台配置方法——需要更为小白逻辑的文档撰写
(2)、Android平台配置方法——需要更为小白逻辑的文档撰写
或者本身是小白菜鸟,尝试以小白菜鸟的方式来理解文档,但是还是很难懂,所以发一下牢骚,也是希望官方能出更小白的文档,正如以上的原因:
1、小白文档更使DCLOUD得到普及;
2、老司机不需求太多文档,小白才要,如果文档要老司机才能读懂,那文档需求不大了,低不下高不就吧。
7 个评论
要回复文章请先登录或注册
badfl
s***@163.com
s***@163.com
赵梦欢
nel (作者)
nel (作者)
赵梦欢