STM32_Study 发表于 2010-4-1 13:49:28

对RT-Thread手册的一些建议~~

首先,对 RT-Thread 开发团队 表示衷心的祝贺。

可以预见,即将发行的套件,对RT-Thread的推广将起到非常有效的作用。

但与此同时,我也有些担心,不知道即将印刷的手册,是不是跟ffxz发布的RT-Thread的编程手册(0.3.0版本)一样的?

如果是这样的话,我建议ffxz暂先不要印刷,请诸位开发成员暂时放下RT-Thread功能、代码方面的工作,先将编程手册校对一遍。

我这几天有空都在看编程手册,感觉存在几个问题:

1、里面的一些低级错误比较多。一方面是排版的问题,另一方面是逻辑上的一些问题。譬如P190、P191上,关于Panel init的代码,里面的坐标明显就是错误的。这些应该是在编写手册时写上去的,并没有经过实际项目的验证。

2、整体上感觉RT-Thread的编程文档写得不够透彻,也许这个跟工作性质有关系。ffxz和其他开发团队成员都是有自己的本职工作,RT-Thread是开源项目,本身并不能直接带来经济利益。因此投入的时间肯定也不够。而且大家都是工程师,对于文案方面,也许并不是自己的强项。
   我作为读者的角度来看(站着说话不腰疼哈),觉得RT-Thread应该多从应用者的角度来说明问题。而举出的范例,最好是能跟当前版本的代码相符合的。
   譬如GUI部分,关于Panel、workbench、View、windows、widgets之间的关系并没有讲透彻,各个模块也没有深入讲解,这样看起来让人有些糊涂。


罗马不是一天能建成的,RT-Thread的各项工作也是一步一步完善。只是作为RT-Thread推广的一个重要里程碑,更顺手改好东西就没必要留到以后来处勘误表了吧?


我很关注RT-Thread的成长,很希望以后的项目中能应用这个系统,以上一家之言,也是想为开源出一份力,如有不对之处,还请原谅

oldtom 发表于 2010-4-1 14:26:55

错误是难免的,如果有错误,那么我们干脆就直接提出来,贴在这里,然后再请ffxz更正下。

STM32_Study 发表于 2010-4-1 14:29:50

是的,我正在整理我发现的一些问题

提这个帖子,只是想建议ffxz暂时不要那么着急印刷,先将手头上的文档校对一遍

毕竟,我们初学者更多的时候,只能发现一些初级的问题和一些排版的上的问题

很多深层的问题需要ffxz他们这些开发内核的人员来看,才能发现

lvhaian 发表于 2010-4-1 14:30:20

【楼主位】 STM32_Study

支持楼主


有没有兴趣和我一起搞 智能充电器 RTT 版本的软件.

可以加我 QQ

armok 发表于 2010-4-1 14:33:05

ffxz 发表于 2010-4-1 15:39:12

多谢STM32_Study的建议。要印刷的版本确实如你所说的,是以 0.3.0发布版本带的RT-Thread编程指南为蓝本来进行的。但也如你帖子里提到的,应用缺少,所以在印刷前会加入一些STM32 Radio项目的解析,以形成 “应用篇”。

错误确实有些难避免,所以还请大家多帮帮忙,同时有好的想法也请提出来(例如说,一个概念可以由一个例子能够更生动的呈现出来)。编程指南的例子我争取尽量使用目前svn上的(/trunk/examples),而应用的例子则是aozima组织的STM32 Radio例子,这样也方便做到例子是测试过、编译过,正确无误的。

排版上确实比较糟糕,下一步争取直接改到LaTex上,这样就不会受sphinx(reStructuredText) --> LaTex的困扰了。

STM32_Study 发表于 2010-4-1 16:48:02

回复【4楼】armok 阿莫
我觉得将目前的版本修正一下,就可以出版了。但每批建议制作50本左右。
可以在我们这里开一个专门的勘误帖子。以前马老师的书效果非常好。
这样,每次新出版的50本,都向前进一步。
如果怕错误不出版,永远不会有出版的机会了。

-----------------------------------------------------------------------

不是怕错误就不出版

我的意思是,就目前的版本而言,由于ffxz他们时间比较紧,文档上没有那么正规化。
但如果要印刷出版的话,起码要走过校正的流程,这个是很有必要的,也不会花很长的时间,我的提议只是希望团队能够重视这些方面,没吹毛求疵的意思



回复【3楼】lvhaian 安哥
【楼主位】 STM32_Study
支持楼主
有没有兴趣和我一起搞 智能充电器 RTT 版本的软件.
可以加我 QQ
-----------------------------------------------------------------------

好的,很期待安哥指点~~~


回复【5楼】ffxz
-----------------------------------------------------------------------

我也会尽快抽时间将我阅读RT-Thread发现的一些疑问提出来,希望能对RT-Thread有帮助~~~

cat_li 发表于 2010-4-1 20:22:29

呵呵,菜鸟路过

lvhaian 发表于 2010-4-2 09:25:16

我 QQ: 1106693754
页: [1]
查看完整版本: 对RT-Thread手册的一些建议~~