docker-vitepress/docs/guide/document-guide.md

文档说明

1. 文档简介

本文档为 HF-MES v5.0 制造执行系统的完整使用指南，旨在帮助用户快速掌握系统的各项功能，顺利完成日常生产管理任务。

文档版本： v1.0
发布日期： 2026-04-10
适用版本： HF-MES v5.0

2. 文档结构

章节	名称	主要内容
文档说明篇	文档管理	文档说明、系统概述
快速入门篇	新手入门	系统登录、快速入门指南
基础配置篇	基础配置	基础数据管理、设备基础信息
生产管理篇	生产执行	生产计划、工单管理、报工管理
质量管理篇	质量追溯	质量检验、质量控制、追溯管理
仓储物流篇	仓储管理	入库管理、出库管理、库存管理
数据集成篇	系统集成	数据接口、系统集成方案
报表分析篇	数据分析	生产报表、质量报表、设备报表
系统运维篇	系统管理	系统管理、系统运维
技术支持篇	技术支持	异常处理、技术支持
附录篇	参考资料	术语表、流程图、更新日志

3. 文档约定

3.1 菜单路径表示

本文档使用【】表示菜单路径，例如：

• 【系统管理】→【用户管理】表示：点击"系统管理"菜单，然后点击"用户管理"子菜单

3.2 界面元素表示

表示方式	含义	示例
【按钮】	操作按钮	【保存】、【取消】
「输入框」	输入控件	「工单编号」
「下拉框」	选择控件	「工单状态」
☐	复选框	☐ 启用
○	单选按钮	○ 新增

3.3 操作步骤表示

操作步骤格式：

1. 第一步操作
2. 第二步操作
3. 第三步操作

3.4 注意事项

标记	含义
【注意】	需要特别注意的事项
【提示】	有助于操作的提示信息
【重要】	必须遵守的重要规则

4. 符号说明

符号	说明	示例
→	操作流向	工单创建 → 工单审核
───▶	流程跳转	提交 ───▶ 审批
│	分支判断	是 │ 否
□	可选项	□ 启用
■	已选项	■ 启用
-	列表项	- 列表内容

5. 排版规范

5.1 标题层级

使用 # 符号表示标题层级：

• 一级标题

• 二级标题

• 三级标题

• 四级标题

5.2 表格格式

列头1	列头2	列头3
内容1	内容2	内容3
内容4	内容5	内容6

5.3 代码块

使用 ``` 包裹代码块，例如：

# 示例命令
cd /opt/mes
./start.sh

6. 文档维护

6.1 更新频率

• 常规更新：每月一次
• 紧急更新：随时发布

6.2 反馈渠道

如果您发现文档内容有误或需要补充，请通过以下方式反馈：

• 邮箱：docs-feedback@hfmes.com
• 服务热线：400-XXX-XXXX

7. Mermaid 流程图测试

7.1 基础流程图示例

以下是一个简单的工单处理流程图示例：

graph TD
    A[工单创建] --> B[工单审核]
    B --> C{审核结果}
    C -->|通过| D[工单执行]
    C -->|驳回| E[修改工单]
    E --> A
    D --> F[报工确认]
    F --> G[质量检验]
    G --> H{检验结果}
    H -->|合格| I[入库]
    H -->|不合格| J[返工]
    J --> D

7.2 序列图示例

sequenceDiagram
    participant 用户
    participant 系统
    participant 设备
    用户->>系统: 提交工单
    系统->>设备: 下发生产指令
    设备->>系统: 报工数据
    系统->>用户: 返回处理结果

8. 版权声明

本文档版权归 HF-MES 所属公司所有，未经许可不得擅自复制、传播或修改。

---

文档说明篇完