docs: 更新文档结构和添加基础模块文档

添加格式标准图片并更新文档结构说明新增厂区模型和工艺流程模型基础模块文档
2026-04-14 10:16:48 +08:00
parent 723edd8f07
commit 80e1091fdf
5 changed files with 344 additions and 6 deletions
--- a/格式标准.md
+++ b/格式标准.md
@@ -1,14 +1,19 @@
 # 一、文档结构层级规范

+
 ## 1.1 标题层级定义

- 一级标题 ：文档主标题，用于封面标识，格式为 # 文档名称
- 页面标题 ：每个页面的标题，对应单独一个md文件 格式为 # 页面标题
- 页面一级标题 ：页面内一级标题，标识主要章节内容、核心业务模块，格式为 ## X. 模块名称
- 页面二级标题 ：页面内二级标题，功能节标题，标识具体功能点，格式为 ### X.X 功能名称
- 页面三级标题 ：页面内三级标题，细节标题，用于细分功能内的具体内容，格式为 #### X.X.X 详细内容
+- 一级标题 ：核心业务模块，对应MES一级标题和文档核心业务文件夹名称
+- 二级标题 ：功能模块标题，对应MES二级标题和文档功能文件名称
+- 三级标题 ：功能节点页面，用于细分功能内的具体内容，格式为 #### X.X.X 详细内容
 - 特殊加强 : 针对特殊加强部分，可以使用 **功能标题：** 进行特殊加强

+![alt text](public\image\格式标准-2.png)
+
+> 标题层级定义中，一级标题对应MES一级标题和文档核心业务文件夹名称，二级标题对应MES二级标题和文档功能文件名称，三级标题对应MES三级标题和文档功能节点页面名称。
+
+> 英文翻译 、 代码模块命名 、文档目录和命名 必须一致，不能有差异。
+
 # 二、标题块书写标准

 ## 2.1 功能概述块标准格式
@@ -104,6 +109,12 @@

 xxxxxx[图片]
 ```
+
+![](public/image/二级模块/格式标准-1.png)
+
+图片命名格式：
+图片描述.png/svg ....
+
 # 五、流程说明块书写标准

 5.1 流程图规范
@@ -114,4 +125,4 @@ xxxxxx[图片]

 # 六、文档样例

-> 查阅 格式样例.md 文件
+> 查阅 basic/factory_model.md 文件