RT-Thread发布新版在线文档中心 优化学习体验
2019-01-14
衡量一个优秀的开源项目,除了高质量的代码,还包括新功能开发、迭代维护,社区交流、推动项目在社区中的使用,提供高质量的文档体系和一定程度的技术答疑等。RT-Thread作为一款受开发者青睐的开源物联网操作系统,在13年的发展中一直坚持“开源、开放”的理念,充分和社区用户交流,稳定维护代码的更新迭代,不断完善优化技术文档,并且提供了活跃的社区技术支持,助力开发者更高效率地进行产品开发。
尤其在近两年,RT-Thread官方团队在文档中心的建设上付出了巨大的努力,取得丰硕成果的同时,也与开发者建立了良性互动。2019年伊始,我们经过多轮意见征询和精心准备,对RT-Thread文档中心进行了全面升级,为初学者和开发者带来更优质的学习和使用体验。
新版在线文档中心即日上线:https://www.rt-thread.org/document/site/
RT-Thread新版文档中心在上线之前,经过了多次开发与迭代。从学习路径、功能模块、实际应用、文档结构等方面入手,做了大量的优化,进一步提升了文档质量,增加丰富了文档内容,真正形成了较为完整的文档体系。针对之前反应的一些主要问题,如文档较为散乱等,也重新梳理了学习路线、重整了文档架构,降低了入门门槛。新版文档中心的主要特性如下:
更加清爽直接的UI界面
如上图所示,RT-Thread新版文档中心主要分成了入门学习、进阶学习、应用开发三大版块,清爽直接一目了然。而侧标题栏,则采用了不同的分类方式,有利于大家寻找更加细化的内容。
更贴合用户需求的学习路线规划
针对用户基础水平参差不齐的情况,我们为用户做了新的学习路线规划参考。明确了用户在不同阶段的学习目的,避免用户在学习过程中产生漫无目的困扰,最大程度地降低了学习成本。概况如下:
入门:目标是把RT-Thread跑起来,并且完成内核部分的学习。
进阶:目标是会使用Env工具,会使用RT-Thread外设、组件、软件包。
应用:目标是能将RT-Thread应用于自己的项目中。
大幅度降低入门难度
尽力降低初学者的学习门槛,让入门变得快速而简单,是我们始终努力的目标。初学者分三步走,即可在数小时内轻松上手RT-Thread。
1.可以在不使用开发板的情况下模拟运行RT-Thread,体验RT-Thread内核和FinSH命令行功能。
2.可以根据不同的基础选择一块学习板,根据各种学习开发板的上手指南,快速将RT-Thread运行起来。
3.根据《内核视频教程》和《RT-Thread编程指南》系统学习RT-Thread内核。
更加丰富且体系化的文档
新版编程指南在老版内容的基础上,重新进行了修订,并且加入了很多新内容。丰富为现在的30章,包含了内核、外设、组件等各方面的内容,支持在线查看的同时也可以下载pdf电子版。
新增了RT-Thread API手册,用户可以对API进行快速的查找。它包含RT-Thread所有API,并且API根据模块归类划分,同时也包含了数据类型、结构体、宏定义和API的使用示例等内容,除了在线查看,也可以下载chm电子书版本。
还针对应用开发,新增各类应用笔记和一些重要的软件包相应的用户手册。
最后,欢迎大家使用RT-Thread全新版在线文档中心,并帮忙反馈问题和给出建议,一起让RT-Thread越来越好!也感谢大家多年来的无私奉献和支持!我们的目的从来不止于做开发者的宠儿,而是做陪你一起进步成长的良友。