From e6fa510f4b3aaa2dbacdd9034b1e8b02da7a8860 Mon Sep 17 00:00:00 2001 From: sheng <905537351@qq.com> Date: Tue, 14 Apr 2026 11:06:58 +0800 Subject: [PATCH] =?UTF-8?q?docs(guide):=20=E6=9B=B4=E6=96=B0=E6=96=87?= =?UTF-8?q?=E6=A1=A3=E7=BB=93=E6=9E=84=E5=B9=B6=E7=AE=80=E5=8C=96=E5=86=85?= =?UTF-8?q?=E5=AE=B9?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - 重构文档目录结构，调整各章节内容 - 删除冗余的文档约定和排版规范说明 - 保留核心的代码块和反馈渠道信息 - 简化版权声明部分 --- guide/document-guide.md | 89 ++++++----------------------------------- 1 file changed, 12 insertions(+), 77 deletions(-) diff --git a/guide/document-guide.md b/guide/document-guide.md index 5f386a9..3e68930 100644 --- a/guide/document-guide.md +++ b/guide/document-guide.md @@ -14,80 +14,22 @@ |------|------|---------| | 文档说明篇 | 文档管理 | 文档说明、系统概述 | | 快速入门篇 | 新手入门 | 系统登录、快速入门指南 | -| 基础配置篇 | 基础配置 | 基础数据管理、设备基础信息 | -| 生产管理篇 | 生产执行 | 生产计划、工单管理、报工管理 | -| 质量管理篇 | 质量追溯 | 质量检验、质量控制、追溯管理 | -| 仓储物流篇 | 仓储管理 | 入库管理、出库管理、库存管理 | -| 数据集成篇 | 系统集成 | 数据接口、系统集成方案 | -| 报表分析篇 | 数据分析 | 生产报表、质量报表、设备报表 | +| 基础配置篇 | 基础配置 | 厂区模型、工艺模型、产品管理、物料模型、班组模型 | +| 生产管理篇 | 生产执行 | 生产批次管理、生产监控、冻结解冻管理、预警中心 | +| 质量管理篇 | 质量追溯 | 首巡检管理、xqc管理、SPC相关| 升 +| 设备管理篇 | 设备管理 | 设备点检、设备保养、设备损耗品管理、设备状态管理、设备维修管理 | 涛 +| 报表分析篇 | 数据分析 | 基础追溯、生产报表 | 涛 +| scada管理篇 | scada管理 | edgemanager、EPS | 伟 +| DAS篇 | DAS分析 | 设备首页、OEE推移分析、稼动分析、设备分析、品质分析 | 升 涛 +| 数据集成篇 | 系统集成 | 数据接口、系统集成方案 | 伟 | 系统运维篇 | 系统管理 | 系统管理、系统运维 | | 技术支持篇 | 技术支持 | 异常处理、技术支持 | | 附录篇 | 参考资料 | 术语表、流程图、更新日志 | -## 3. 文档约定 -### 3.1 菜单路径表示 +## 3. 代码块 -本文档使用【】表示菜单路径，例如： - -- 【系统管理】→【用户管理】表示：点击"系统管理"菜单，然后点击"用户管理"子菜单 - -### 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 代码块 +### 3.1 使用 ``` 包裹代码块，例如： @@ -97,21 +39,14 @@ cd /opt/mes ./start.sh ``` -## 6. 文档维护 - -### 6.1 更新频率 - -- 常规更新：每月一次 -- 紧急更新：随时发布 - -### 6.2 反馈渠道 +## 4. 反馈渠道 如果您发现文档内容有误或需要补充，请通过以下方式反馈： - 邮箱：docs-feedback@hfmes.com - 服务热线：400-XXX-XXXX -## 7. 版权声明 +## 5. 版权声明 本文档版权归 HF-MES 所属公司所有，未经许可不得擅自复制、传播或修改。