火箭系统性文档

本项目是一个面向实验火箭的系统性文档留存,用于记录火箭的设计理念,仿真数据,源代码维护,3D模型,以及各种可被文字化留存的知识

目标是形成一个不需要靠口头传授就可以轻易获取的知识库,提升工作效率和协作效率


网站概述

本网站以mkdocs为底层网站生成器,并使用github进行网站托管,源代码仓库为 仓库地址


网站结构

当前网站以火箭各个系统工程的领域作为主分区依据,主要划分位以下几个区块:

  • 结构设计:火箭的外部机械结构设计
  • 航电系统:火箭的电子系统设计
  • 推进系统:发动机设计以及相关资料
  • 仿真分析:用于存放所有的仿真结果
  • 飞行记录:以飞行航次为单位,记录每次飞行的具体数据信息

协作流程

为了避免各成员之间的同时修改会导致git流混乱,所以本网站的修改流程采用Pull-Requset形式,每个成员需要克隆一个仓库到自己名下新建分支,将新更改在新分支下进行并提交PR。 详细的协作流程请看:docsWorkflow


文档目标

大学内的科技社团,经常出现两种非常不好的现象,一种是老资历掌握过度话语权和解释权,另一种是周期性的技术断代。而这两种现象其实都可以指向一个共同的原因,就是团体内没有建立很好的信息记录的手段,所有的信息都只能通过口头传承和手把手教授的方式来传递,虽然说工程领域的知识并不是所有都能文字化来记录下来,但至少我们可以在面临一些重复性问题的时候不再从头走一遍之前的老路。本文档的目标是,当以后再出现一些火箭开发上面的bug或问题时,想要去找一找之前是怎么解决的,或者找一找之前的源码是怎么写的,之前的3D图是怎么画的,不需要再去找某个当年的人来问或者翻开电脑的文件夹找半天也没找到。我们只需要打开rocket.wiki,打开对应板块,就能了解到之前踩过的坑,某年某月某日的试车记录,这将会大大提升我们的协作效率和技术的可留存性。同时,记录文档的过程本身也是一种梳理思想的过程,如果你在开发中没法将你做的东西梳理成文档,那就说明你还对你开发的东西没有精确的把握和认知,可能还停留在“感觉”的层面,这时候,停下来梳理文档将是一次非常好的思维梳理过程。