nel
nel
  • 发布:2016-05-15 21:26
  • 更新:2016-05-15 21:26
  • 阅读:1155

牢骚天书一样阅读DCloud文档并顺便提小建议

分类:HTML5+

我是小白菜鸟一名,所以对文档需求很是强烈的。
但是阅读来去,云里雾里的。
总结一下: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、老司机不需求太多文档,小白才要,如果文档要老司机才能读懂,那文档需求不大了,低不下高不就吧。

4 关注 分享
noobapp ssdate@163.com 1650584799@qq.com 吴上阿江

要回复文章请先登录注册

badfl

badfl

http://ask.dcloud.net.cn/article/1039
我自己整理的文档,持续更新中,参照一下
2016-12-01 10:07
ssdate@163.com

ssdate@163.com

回复 ssdate@163.com :
话说我用的是MUI,而且是官方的demo,原款引用过来,页面也只是空白,但是使用MUI自定义了一个页面,却能正常显示,我在自己的webview里完全正常,这让人有点摸不着头脑。
2016-06-19 14:55
ssdate@163.com

ssdate@163.com

现在就在做一个hybrid app 按照文档去集成,结果发现没有什么效果,页面显示不出来,我原来自己写的webview加载页面没有问题,研究了一天,感觉还是没弄明白,难道是我太小白了 (┬_┬)。 希望有更详细的参考。现在就只是想把最基础的H5框架集成进来,感觉都难。
2016-06-19 12:48
赵梦欢

赵梦欢

回复 nel :
不用谢,后续会发布更多基础教程
2016-05-16 11:27
nel

nel (作者)

回复 赵梦欢 :
是的,很多确实是不够理解啊,谢谢提供教程。
2016-05-16 01:26
nel

nel (作者)

是的,很多确实是不够理解啊,谢谢提供教程。
2016-05-16 01:25
赵梦欢

赵梦欢

最近准备针对小白用户写入门教程,今天写了一篇,不过相对于楼主提出的要求来说还是不够细致,不过这里可以参考一下。http://zhaomenghuan.github.io/blog/h/20160515.html 楼主之所以会疑惑是因为你没有搞清楚html5+对于dcloud这边产品的重要性,一般的平台同样提供sdk,不过是做为插件提供,所以存在你所说的引用问题,然而dcloud这边提供的是一种标准,就是你首先得基于html5+这种标准去实现提升h5的性能,如果你用hbuilder建基于html5+的app,那么按照一般逻辑依然是如果无需引用就支持最好,如果你不是离线打包和做hybrid app,你可以先不用管sdk这块。
2016-05-15 23:44