文档写作格式规范

文档AI等级：2

1.1 文档源码结构

源码结构为：

docs/                 # 文档文件夹
└── index.md                # 首页
│
└── development/             # 开发规范
│   └── index.md                # 首页
│   └── docs_workflow           # 文档工作流
│   └── ....
│
└── structures/              # 结构性文档入口
│   └── index.md                # 首页
│   └── ....
│
└── flight_records/          # 飞行记录入口
│   └── index.md                # 首页
│   └── ....
│
└── propulsion/              # 喷气推进相关入口
│   └── index.md                # 首页
│   └── ....
|
└── simulation/              # 仿真相关入口
│   └── index.md                # 首页
│   └── ....
│
└── avionics/                # 航电系统入口
│   └── index.md                # 首页
│   └── ....
│
└── assets/                  # 图片存放处
    └── index.md                # 首页
    └── ....

mkdocs.yml                   # mkdocs配置文件，负责网站的结构和样式

而我们在更改的过程中秩序在docs/文件夹下找到对应自己要更改的领域，然后新建.md文件即可

1.2 文件命名规范

所有文件的命名都采用：小写字母加英文下划线的格式，例如:

• development/
• docs_workflow.md
• motor_test.md
• rocket_motor.petg

但是如果涉及到较为复杂的整体性的文件夹移植，而牵扯的内部文件格式已经形成定式的时候，可以保持其内部的自己命名法则，例如源码或者3d模型文件夹，但外部的包装文件夹依旧采用上述命名格式

1.3 MarkDown写作规范

.md文件内部不做过于严格的写作规范，但请尽量依照之前的文件的风格进行，并保持md文件清晰可读。

1.4 AI成分标注

为使文档阅读者在阅读文档是能够能清晰的了解当前文档的写作方法以及可信度，对于文字类的文档，每个文档前必须标注AI的使用等级，用于辨识此文档内AI的使用比例

示例：

AI等级：3

现规定AI等级如下：

• 0级：通篇没有使用任何的AI工具，包括但不限于使用Ai搜索资料、查重、修缮等。全文AI生成比例为0%。
• 1级：使用了AI工具，但AI使用纯用于查找资料、翻译或基础语言，没有让AI提出任何开创性的想法或者想法的整合，相当于AI是一个更进一步的谷歌引擎。
• 2级：使用AI工具作为数据搜索和想法建设，AI参与局部分析、思路发散、措辞优化或小范围内容生成。但文章主体结构、技术判断和结论由作者独立完成。
• 3级：使用AI工具不断优化想法和观点，规划整体结构，作者对全文内容进行人工重构、核查并承担最终技术判断。
• 4级：AI承担主要文本生成工作，作者主要提供核心资料和提示词
• 5级：全部由AI生成

AI等级并没有好坏，按真实标注即可

1.5 文档内容结构

文档的组织结构以文件夹为单位，每一个具有导航意义的目录必须包含一个index.md，作为该目录的入口页面。而根据当前层级的index.md里面向下链接的按钮可以进入下层文件夹。纯资源目录（如 assets）不需要建立网页入口

最终体现形式类似于树形结构

以avionics（航电）文件夹作为示例来解释：

avionics/
└── index.md             # “航电”主界面的网页
|   └── 航电总体介绍
|   └── V1版本航电链接    # 通向v1/index.md
|   └── V2版本航电连接    # 通向v2/index.md
| 
└── v1/
|   └── assets/              # V1版本附件存放区（图片、PDF、源码等文件）
|   └── index.md             # v1版本航电基本介绍
|       └── 硬件系统             # 调用v1/assets内的文件
|       └── 软件系统             # 调用v1/assets内的文件
| 
└── v2/
|   └── assets/              # V2版本附件存放区（图片、PDF、源码等文件）
|   └── index.md             # v2版本航电基本介绍
|       └── 硬件系统             # 调用v1/assets内的文件
|       └── 软件系统             # 调用v1/assets内的文件

可以看到，在主页中显示的若干的大文件夹每个分区有一个单独的index界面，可以根据这个单独的index界面再去细分进下级的各个文件夹（V1、V2），下层的每个文件夹也各自掌握着一个index.md用于展示和链接，同时，每个文件夹都配备一个assets文件夹作为附件存储区，assets目录用于存放仅服务于当前目录文档的资源文件。

建议assets内也采用多个文件夹来进行资源区分，例如picture、code、hardware