Kerloud飞控系列教程(21): 如何寻找使用开发说明文档

Kerloud飞控系列教程(21): 如何寻找使用开发说明文档

开发说明文档的重要性

对于开源项目,规范的开发说明文档是非常重要的。github上面有很多开源软件,一般受欢迎的项目都会有比较好的readme或者在线文档指引,使用户可以方便地尝试,借此扩大软件影响力。

PX4项目在多年的发展中形成了较为庞大的文档记录,而且随着版本的更新,文档记录归档变得更加复杂,表现在:不同分支的对应文档不同,部分文档更新有滞后,通过搜索引擎得到的结果和版本对应性较差。这几个问题是初学者必将遇到的问题,尤其是对软件开发流程陌生的情况下。

怎么寻找

px4社区存在的官方文档链接有以下几个:

对于行业产品用户而言,最新的文档指引很多时候不是我们要找的,我们经常需要找到对应自己开发版本的文档,比如我们Kerloud飞控对应的版本有v1.10, v1.11, v1.13等,还有一些深度开发者可能会长期在某个版本上进行开发。

(1) 在网页中寻找

打开链接http://docs.px4.io/main/en/index.html,在右上角可以选择version,选择对应的版本,这样就可以找到对应过去版本的使用文档,注意这不是开发者文档,只是关于px4飞控使用层面的。

对于早期的开发者文档,https://dev.px4.io/ 会直接跳转到最新的使用指引,链接失效,只能通过下面的第二种方法找到。

(2) 在文档repo库寻找

最新使用指引文档库:https://github.com/PX4/PX4-user_guide

早期开发者文档库:https://github.com/PX4/dev.px4.io

早期使用指引文档库:https://github.com/PX4/docs.px4.io

我们可以把这些文档库通过git下载到本地电脑,比如我们可以通过dev.px4.io获得早期版本的开发指引,在v1.10_noredirect 文件夹中点击index.html,然后再点击en/index.html,就可以在浏览器中浏览文档了。

我们的经验是早期的开发文档质量很高,最新版本因为维护者有些分散,反而参考价值不高,我们推荐Kerloud飞控的用户多阅读早期版本的对应文档,对开发大有裨益。

回到教程目录:Kerloud飞控系列教程(1):目录