James/docker-vitepress
1
0
Fork 0
Code Issues Pull Requests 1 Actions Packages Projects Releases Wiki Activity

Initial commit

Browse Source
This commit is contained in:
james
2026-05-19 22:27:43 +08:00
commit 2ee120f756
33 changed files with 11949 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

75
.gitignore vendored Normal file
View File

@@ -0,0 +1,75 @@
# Environment files (敏感配置)
.env
.env.local
.env.production
!.env.example
# Dependencies
node_modules/
.pnpm-store/
**/node_modules/
# Build outputs
docs/.vitepress/dist/
docs/.vitepress/cache/
**/.vitepress/dist/
**/.vitepress/cache/
# PDF exports (导出的 PDF 文件不应提交)
*.pdf
!*.example.pdf
# Docker
docker/tmp/
docker/*.log
**/*.log
# Logs
*.log
npm-debug.log*
yarn-debug.log*
yarn-error.log*
pnpm-debug.log*
lerna-debug.log*
# OS
.DS_Store
Thumbs.db
ehthumbs.db
*.swp
*.swo
*~
.fuse_hidden*
.Directory
Desktop.ini
# IDE
.vscode/
.idea/
*.suo
*.ntvs*
*.njsproj
*.sln
*.sw?
*.sublime-workspace
*.sublime-project
# Temporary files
*.tmp
*.temp
.cache/
.tmp/
temp/
# Test coverage
coverage/
.nyc_output/
# Build artifacts
dist/
build/
*.tgz
# Misc
*.local
*.log

103
README-VITEPRESS.md Normal file
View File

@@ -0,0 +1,103 @@
# VitePress 使用手册
基于 VitePress 构建的使用手册。
## 📖 文档预览
本手册采用 VitePress 构建，支持实时预览和静态站点生成。
## 🚀 快速开始
### 准备package.json文件
文件夹下具备 package.json 文件
json文件结构如下：
```json
{
"name": "docs-vitepress",
"version": "1.0.0",
"description": "vitepress在线文档",
"scripts": {
"docs:dev": "vitepress dev docs",
"docs:build": "vitepress build docs",
"docs:preview": "vitepress preview docs",
"export-pdf": "press-export-pdf export docs"
},
"devDependencies": {
"vitepress": "latest",
"vitepress-export-pdf": "^1.0.0"
}
}
```
### 安装依赖
执行以下命令安装依赖：
```bash
npm install
```
### 开发预览
```bash
npm run docs:dev
```
### 构建静态站点
```bash
npm run docs:build
```
### 预览构建结果
```bash
npm run docs:preview
```
## 📁 文档结构
```
docs/
├── .vitepress/
│ └── config.mjs # VitePress 配置
├── guide/ # 文档说明
│ ├── document-guide.md
│ └── system-overview.md
├── getting-started/ # 快速入门
│ └── quick-start.md
├── basic/ # 基础配置
│ ├── data-management.md
│ └── equipment.md
├── business/ # 业务模块
│ ├── production.md
│ ├── quality.md
│ └── equipment-warehouse.md
├── integration/ # 数据集成
│ └── data-integration.md
├── analysis/ # 报表分析
│ └── reports.md
├── operation/ # 系统运维
│ ├── system-operation.md
│ └── technical-support.md
├── appendix/ # 附录
│ └── glossary.md
└── index.md # 首页
```
## 🔧 配置说明
VitePress 配置文件位于 `docs/.vitepress/config.mjs`，包含以下配置：
- 网站标题和描述
- 导航栏配置
- 侧边栏配置
- 主题配置
- Markdown 配置
## 📦 技术栈
- [VitePress](https://vitepress.dev/) - Vite 驱动的静态站点生成器
- [Vue.js](https://vuejs.org/) - 渐进式 JavaScript 框架

343
README.md Normal file
View File

@@ -0,0 +1,343 @@
# VitePress Docker 部署指南
## 概述
本项目提供了完整的 VitePress 文档系统 Docker 部署方案，包含 VitePress 文档服务、API 服务和 PDF 导出功能。
## 功能特性
- ✅ VitePress 文档服务（端口 3000）
- ✅ RESTful API 服务（端口 3001）
- ✅ PDF 导出功能
- ✅ 中文、俄语等多语言字体支持
- ✅ 跨平台部署支持
## 系统要求
- Docker 20.10+
- Docker Compose 2.0+
- 至少 2GB 可用内存
## 快速开始
### 1. 准备配置文件
在项目根目录创建 `.env` 文件：
```bash
# VitePress 文档服务器端口
VITEPRESS_PORT=3000
# API 服务器端口
API_PORT=3001
# 文档目录路径（相对于项目根目录）
DOCS_DIR=./docs
```
### 2. 构建并启动服务
```bash
# 构建镜像并启动服务
docker-compose up --build
# 或者后台运行
docker-compose up --build -d
```
### 3. 验证服务状态
访问以下地址确认服务正常运行：
- **VitePress 文档**: http://localhost:3000
- **API 健康检查**: http://localhost:3001/health
## 目录结构
```
hf-mes-docs-vitepress/
├── docker/
│ ├── api/
│ │ ├── server.js # API 服务主文件
│ │ └── package.json # API 依赖
│ ├── Dockerfile # Docker 镜像构建文件
│ └── docker-entrypoint.sh # 容器启动脚本
├── docs/ # VitePress 文档目录 **生产时使用**
│ ├── .vitepress/
│ │ ├── config.mjs # VitePress 配置
│ │ └── vitepress-pdf.config.ts # PDF 导出配置
│ ├── index.md # 首页
│ ├── guide/ # 指南目录
│ ├── getting-started/ # 入门目录
│ └── ... # 其他文档
├── docker-compose.yml # Docker Compose 配置
├── package.json # 项目依赖 **构建docker时使用**
└── .env # 环境变量配置
```
## 常用命令
### 直接拉取image
```bash
docker pull xeden3/vitepress-docker:latest
```
### 启动服务
```bash
# 前台运行
docker-compose up
# 后台运行
docker-compose up -d
# 重新构建并启动
docker-compose up --build
```
### 停止服务
```bash
# 停止服务
docker-compose down
# 停止并删除数据卷
docker-compose down -v
```
### 查看日志
```bash
# 查看所有日志
docker-compose logs -f
# 查看 API 服务日志
docker-compose logs -f api
# 查看最近 100 行日志
docker-compose logs --tail=100
```
### 重启服务
```bash
# 重启所有服务
docker-compose restart
```
## 环境变量配置
### 可用环境变量
| 变量名 | 默认值 | 说明 |
|--------|--------|------|
| `VITEPRESS_PORT` | 3000 | VitePress 文档服务端口 |
| `API_PORT` | 3001 | API 服务端口 |
| `DOCS_DIR` | ./docs | 文档目录（支持绝对路径和相对路径） |
| `DOCS_PATH` | /app/docs | 容器内文档路径（固定值） |
### 配置示例
#### 使用相对路径（默认）
```bash
DOCS_DIR=./docs
```
#### 使用绝对路径
**Windows:**
```bash
DOCS_DIR=C:\Users\xeden\Desktop\MES使用手册\hf-mes-docs-vitepress\docs
```
**Linux/Mac:**
```bash
DOCS_DIR=/home/user/docs
```
## 自定义文档目录
默认情况下，Docker 会挂载项目根目录下的 `./docs` 文件夹到容器的 `/app/docs`。
### 方法一：通过 .env 文件
在项目根目录的 `.env` 文件中修改：
```bash
DOCS_DIR=./docs
```
### 方法二：通过命令行
```bash
# Linux/Mac
DOCS_DIR=/custom/path docker-compose up -d
# Windows PowerShell
$env:DOCS_DIR="C:\custom\docs"; docker-compose up -d
```
### 方法三：修改 docker-compose.yml
直接修改 `docker-compose.yml` 文件中的 `volumes` 配置：
```yaml
volumes:
- /your/custom/path:/app/docs
```
## PDF 导出功能
### 使用 API 导出 PDF
API 服务提供以下端点：
#### 健康检查
```bash
curl http://localhost:3001/health
```
#### 导出 PDF
```bash
curl "http://localhost:3001/export-pdf"
```
#### 查看已导出的 PDF
```bash
curl http://localhost:3001/pdf-files
```
### PDF 文件位置
导出的 PDF 文件保存在你配置的 `DOCS_DIR` 目录下。
### 导出配置
PDF 导出使用 `vitepress-export-pdf` 插件，配置位于：
```
docs/.vitepress/vitepress-pdf.config.ts
```
如需自定义 PDF 导出选项，请修改该配置文件。
**导出文件名与 `vitepress-pdf.config.ts` 配置一致**
## 多语言支持
Docker 镜像已包含以下字体支持：
- ✅ 中文字体（文泉驿、Noto CJK）
- ✅ 俄文字体（DejaVu）
- ✅ 其他语言字体
### 使用自定义字体
如需使用 Windows 雅黑字体，可以：
1. 从 Windows 系统复制字体文件：
```bash
# 假设容器名称为 vitepress-docker
docker cp C:\Windows\Fonts\msyh.ttc vitepress-docker:/usr/share/fonts/truetype/
```
2. 进入容器更新字体缓存：
```bash
docker exec vitepress-docker fc-cache -fv
```
3. 重新导出 PDF 即可使用新字体
## 故障排除
### 容器无法启动
1. 检查端口占用：
```bash
# Windows
netstat -ano | findstr 3000
netstat -ano | findstr 3001
# Linux/Mac
netstat -tuln | grep -E '3000|3001'
```
2. 检查 Docker 状态：
```bash
docker ps
docker-compose ps
```
3. 查看错误日志：
```bash
docker-compose logs --tail=50
```
### 文档目录挂载失败
1. 确认目录存在：
```bash
ls -la ./docs
```
2. 检查权限：
```bash
# Linux/Mac 可能需要授权
chmod 755 ./docs
```
3. 使用绝对路径尝试
### PDF 导出失败
1. 检查容器日志：
```bash
docker-compose logs -f
```
2. 验证 Chromium 安装：
```bash
docker exec vitepress-docker which chromium
```
3. 检查文档目录权限：
```bash
docker exec vitepress-docker ls -la /app/docs
```
4. 确认 VitePress 服务正常运行：
```bash
curl http://localhost:3000
```
### 服务无法访问
1. 检查容器状态：
```bash
docker ps | grep vitepress
```
2. 检查防火墙设置：
```bash
# Windows
netsh advfirewall firewall show rule name="Docker VitePress"
```
3. 尝试重启服务：
```bash
docker-compose restart
```
## 技术栈
- **基础镜像**: Node.js 25
- **Web 服务器**: Express.js
- **文档框架**: VitePress
- **PDF 导出**: vitepress-export-pdf
- **浏览器引擎**: Chromium (Puppeteer)
- **容器化**: Docker + Docker Compose

32
docker-compose.yml Normal file
View File

@@ -0,0 +1,32 @@
services:
vitepress:
build:
context: .
dockerfile: docker/Dockerfile
image: xeden3/vitepress-docker:latest
container_name: vitepress-docker
ports:
- "${VITEPRESS_PORT:-3000}:${VITEPRESS_PORT:-3000}"
- "${API_PORT:-3001}:${API_PORT:-3001}"
environment:
- NODE_ENV=production
- VITEPRESS_PORT=${VITEPRESS_PORT:-3000}
- API_PORT=${API_PORT:-3001}
- DOCS_PATH=/app/docs
- PUPPETEER_EXECUTABLE_PATH=/usr/bin/chromium
- PUPPETEER_SKIP_CHROMIUM_DOWNLOAD=true
volumes:
- ${DOCS_DIR:-./docs}:/app/docs
restart: unless-stopped
healthcheck:
test: ["CMD", "wget", "--quiet", "--tries=1", "--spider", "http://localhost:${API_PORT:-3001}/health"]
interval: 30s
timeout: 10s
retries: 3
start_period: 40s
networks:
- vitepress-network
networks:
vitepress-network:
driver: bridge

420
docker/API.md Normal file
View File

@@ -0,0 +1,420 @@
# VitePress API Documentation
## 概述
VitePress Docker 服务提供了一套完整的 RESTful API，用于管理文档系统和 PDF 导出功能。
## 服务地址
- **API 服务**: `http://localhost:3001`
- **VitePress 文档**: `http://localhost:3000`
## API 端点概览
| 方法 | 端点 | 描述 |
|------|------|------|
| GET | `/health` | 健康检查 |
| GET | `/export-pdf` | 导出 PDF |
| GET | `/pdf-files` | 列出所有 PDF 文件 |
---
## API 端点详情
### 1. 健康检查
**端点**: `GET /health`
检查 API 服务和 VitePress 服务是否正常运行。
**响应示例**:
```json
{
"status": "ok",
"timestamp": "2026-04-11T12:00:00.000Z",
"services": {
"api": "running",
"vitepress": "running"
}
}
```
**状态码**:
- `200 OK`: 服务正常运行
**curl 示例**:
```bash
curl http://localhost:3001/health
```
---
### 2. 导出 PDF
**端点**: `GET /export-pdf`
启动 PDF 导出流程，将当前 VitePress 文档导出为 PDF 文件。
**请求参数**:
| 参数 | 类型 | 必需 | 默认值 | 说明 |
|------|------|------|--------|------|
| `fileName` | string | 否 | `export-{timestamp}.pdf` | 导出文件名 |
**示例请求**:
```bash
# 使用默认文件名
curl "http://localhost:3001/export-pdf"
# 指定文件名
curl "http://localhost:3001/export-pdf?fileName=HF-MES-Manual.pdf"
```
**成功响应**:
```json
{
"success": true,
"message": "PDF exported successfully",
"pdfPath": "/app/docs/HF-MES-Manual.pdf",
"pdfUrl": "HF-MES-Manual.pdf",
"fileName": "HF-MES-Manual.pdf",
"fileSize": 1234567,
"fileSizeMB": "1.18"
}
```
**错误响应**:
```json
{
"success": false,
"error": "PDF file was not created",
"stack": "Error: PDF file was not created..."
}
```
**状态码**:
- `200 OK`: PDF 导出成功
- `500 Internal Server Error`: 导出失败
**工作流程**:
1. 清理旧的 `.vitepress/dist` 目录
2. 检查 VitePress 开发服务器是否运行
3. 执行 `npm run export-pdf` 命令
4. 查找生成的 PDF 文件
5. 返回 PDF 文件信息
**注意事项**:
- PDF 文件会保存到配置的 `DOCS_DIR` 目录下
- 如果 VitePress 服务未运行，导出会失败
- 首次导出可能需要较长时间
---
### 3. 列出 PDF 文件
**端点**: `GET /pdf-files`
列出 `DOCS_DIR` 目录下所有已导出的 PDF 文件。
**响应示例**:
```json
{
"count": 2,
"files": [
{
"name": "HF-MES-Manual.pdf",
"size": 1234567,
"sizeMB": "1.18",
"created": "2026-04-11T12:00:00.000Z",
"modified": "2026-04-11T12:00:00.000Z"
},
{
"name": "export-123456.pdf",
"size": 2345678,
"sizeMB": "2.24",
"created": "2026-04-11T11:00:00.000Z",
"modified": "2026-04-11T11:00:00.000Z"
}
]
}
```
**文件信息字段**:
| 字段 | 类型 | 说明 |
|------|------|------|
| `name` | string | 文件名 |
| `size` | number | 文件大小（字节） |
| `sizeMB` | string | 文件大小（MB，保留两位小数） |
| `created` | string | 文件创建时间（ISO 8601） |
| `modified` | string | 文件最后修改时间（ISO 8601） |
**状态码**:
- `200 OK`: 成功获取文件列表
- `500 Internal Server Error`: 读取目录失败
**curl 示例**:
```bash
curl http://localhost:3001/pdf-files
```
---
## 使用示例
### 完整的 PDF 导出流程
```bash
# 1. 检查服务状态
curl http://localhost:3001/health
# 2. 导出 PDF（指定文件名）
curl "http://localhost:3001/export-pdf?fileName=My-Document.pdf"
# 3. 查看导出的文件
curl http://localhost:3001/pdf-files
# 4. 在浏览器中访问
# http://localhost:3000/My-Document.pdf
```
### 使用 JavaScript 调用
```javascript
// 检查服务状态
async function checkHealth() {
const response = await fetch('http://localhost:3001/health');
const data = await response.json();
console.log('Service Status:', data);
}
// 导出 PDF
async function exportPDF(fileName = null) {
const url = fileName
? `http://localhost:3001/export-pdf?fileName=${fileName}`
: 'http://localhost:3001/export-pdf';
const response = await fetch(url);
const data = await response.json();
if (data.success) {
console.log('PDF exported:', data.fileName);
console.log('File size:', data.fileSizeMB, 'MB');
} else {
console.error('Export failed:', data.error);
}
}
// 获取 PDF 列表
async function listPDFs() {
const response = await fetch('http://localhost:3001/pdf-files');
const data = await response.json();
console.log(`Found ${data.count} PDF files:`);
data.files.forEach(file => {
console.log(` - ${file.name} (${file.sizeMB} MB)`);
});
}
```
### 使用 Python 调用
```python
import requests
# 检查服务状态
def check_health():
response = requests.get('http://localhost:3001/health')
print(response.json())
# 导出 PDF
def export_pdf(file_name=None):
url = 'http://localhost:3001/export-pdf'
if file_name:
url += f'?fileName={file_name}'
response = requests.get(url)
data = response.json()
if data['success']:
print(f"PDF exported: {data['fileName']}")
print(f"File size: {data['fileSizeMB']} MB")
else:
print(f"Export failed: {data['error']}")
# 列出 PDF 文件
def list_pdfs():
response = requests.get('http://localhost:3001/pdf-files')
data = response.json()
print(f"Found {data['count']} PDF files:")
for file in data['files']:
print(f" - {file['name']} ({file['sizeMB']} MB)")
```
---
## 错误处理
### 常见错误
| 错误信息 | 可能原因 | 解决方案 |
|----------|----------|----------|
| `PDF file was not created` | VitePress 服务未运行 | 确认 http://localhost:3000 可访问 |
| `Export command failed` | PDF 导出命令执行失败 | 检查容器日志 |
| `ENOENT: no such file or directory` | 文档目录不存在 | 确认 DOCS_DIR 配置正确 |
### 错误响应格式
所有错误响应都遵循以下格式：
```json
{
"success": false,
"error": "错误描述信息",
"stack": "错误堆栈信息（仅在开发环境显示）"
}
```
---
## 配置说明
### 环境变量
| 变量名 | 默认值 | 说明 |
|--------|--------|------|
| `API_PORT` | 3001 | API 服务端口 |
| `DOCS_PATH` | /app/docs | 容器内文档目录路径 |
| `VITEPRESS_PORT` | 3000 | VitePress 服务端口 |
| `NODE_ENV` | production | Node.js 运行环境 |
### Docker Compose 配置
```yaml
services:
vitepress:
environment:
- API_PORT=3001
- DOCS_PATH=/app/docs
- VITEPRESS_PORT=3000
- NODE_ENV=production
ports:
- "3001:3001"
volumes:
- ${DOCS_DIR:-./docs}:/app/docs
```
---
## 注意事项
1. **PDF 文件位置**: 导出的 PDF 文件保存在配置的 `DOCS_DIR` 目录下，可直接在浏览器中通过 VitePress 服务访问
2. **VitePress 服务依赖**: PDF 导出功能依赖 VitePress 开发服务器运行，请确保 http://localhost:3000 可访问
3. **导出超时**: PDF 导出命令超时时间设置为 3 分钟，大型文档可能需要更长的时间
4. **并发限制**: 不建议同时发起多个 PDF 导出请求
5. **CORS 支持**: API 服务已启用 CORS，允许来自任何源的请求
6. **文件覆盖**: 如果指定文件名已存在，导出时会被覆盖
---
## 技术实现
### API 服务架构
```
Express.js Server (端口 3001)
├── /health → 直接返回状态
├── /export-pdf → 执行 export-pdf 脚本
└── /pdf-files → 读取 DOCS_DIR 目录
```
### PDF 导出流程
```
1. Client Request
↓
2. Clean .vitepress/dist
↓
3. Check VitePress Server
↓
4. Execute npm run export-pdf
↓
5. Find Generated PDF
↓
6. Return Response
```
### 依赖项
- **express**: Web 框架
- **cors**: 跨域资源共享
- **fs-extra**: 文件系统操作
- **vitepress-export-pdf**: PDF 导出插件
---
## 故障排除
### 服务无法访问
1. 检查容器状态：
```bash
docker ps | grep vitepress
```
2. 检查端口占用：
```bash
netstat -ano | findstr 3001
```
3. 查看日志：
```bash
docker-compose logs -f vitepress
```
### PDF 导出失败
1. 确认 VitePress 服务运行：
```bash
curl http://localhost:3000
```
2. 检查容器日志：
```bash
docker-compose logs -f
```
3. 验证文档目录挂载：
```bash
docker exec vitepress-docker ls -la /app/docs
```
4. 检查权限：
```bash
docker exec vitepress-docker whoami
```
### 文件列表为空
1. 确认 PDF 文件存在：
```bash
ls -la ./docs/*.pdf
```
2. 检查 DOCS_DIR 配置：
```bash
cat .env | grep DOCS_DIR
```
---
如有问题，请查看容器日志或联系技术支持。

97
docker/Dockerfile Normal file
View File

@@ -0,0 +1,97 @@
# VitePress Docker Image
FROM node:25
LABEL maintainer="xeden3"
LABEL description="VitePress Documentation with PDF Export Support"
# Install Chrome dependencies for PDF export (Debian)
RUN apt-get update && apt-get install -y \
chromium \
chromium-driver \
tzdata \
fonts-liberation \
libnss3 \
libatk-bridge2.0-0 \
libxcomposite1 \
libxdamage1 \
libxrandr2 \
libgbm1 \
libasound2 \
libpangocairo-1.0-0 \
libgtk-3-0 \
libxss1 \
libglib2.0-0 \
libxkbcommon0 \
libdrm2 \
libcups2 \
libdbus-1-3 \
# 中文字体支持（开源字体，Docker环境默认使用）
fonts-wqy-microhei \
fonts-wqy-zenhei \
xfonts-intl-chinese \
fonts-noto-cjk \
# 俄语字体支持（DejaVu 字体包含 Cyrillic 字符）
fonts-dejavu-core \
# 字体缓存工具
fontconfig \
&& fc-cache -fv \
&& rm -rf /var/lib/apt/lists/*
# 提示：如果需要使用微软雅黑字体，可以从 Windows 系统复制字体文件到容器
# Windows 字体目录：C:\Windows\Fonts\msyh.ttc (微软雅黑)
# 将字体复制到容器：docker cp msyh.ttc <container_name>:/usr/share/fonts/truetype/
# 然后运行：fc-cache -fv
# Set environment variables
ENV PUPPETEER_SKIP_CHROMIUM_DOWNLOAD=true \
PUPPETEER_EXECUTABLE_PATH=/usr/bin/chromium \
NODE_ENV=development \
CHROME_BIN=/usr/bin/chromium
WORKDIR /app
# Copy package files for main app
COPY package*.json ./
# Install main dependencies (vitepress, etc.)
RUN export NODE_ENV=development && \
rm -rf node_modules package-lock.json && \
npm install && \
npm install vitepress-export-pdf -D && \
npm install vitepress-plugin-mermaid mermaid && \
npm install medium-zoom markdown-it-mathjax3
# Copy API service
COPY docker/api/package*.json ./api/
WORKDIR /app/api
# Install API dependencies
RUN npm install
# Go back to app directory
WORKDIR /app
# Copy API service files
COPY docker/api/ ./api/
# Copy entry point script
COPY docker/docker-entrypoint.sh /docker-entrypoint.sh
RUN chmod +x /docker-entrypoint.sh
# Create log directory
RUN mkdir -p /var/log
# Create working directory for docs
WORKDIR /app
# Expose ports
EXPOSE ${VITEPRESS_PORT:-3000} ${API_PORT:-3001}
# Volume for docs and PDF output
VOLUME ["/app/docs"]
WORKDIR /app
# Entry point
ENTRYPOINT ["/docker-entrypoint.sh"]
CMD []

16
docker/api/package.json Normal file
View File

@@ -0,0 +1,16 @@
{
"name": "vitepress-pdf-api",
"version": "1.0.0",
"description": "API service for VitePress PDF export",
"main": "server.js",
"type": "module",
"scripts": {
"start": "node server.js"
},
"dependencies": {
"express": "^4.18.2",
"cors": "^2.8.5",
"child_process": "^1.0.2",
"fs-extra": "^11.1.1"
}
}

220
docker/api/server.js Normal file
View File

@@ -0,0 +1,220 @@
import express from 'express';
import cors from 'cors';
import { exec } from 'child_process';
import { promisify } from 'util';
import fs from 'fs-extra';
import path from 'path';
import { fileURLToPath } from 'url';
const execAsync = promisify(exec);
const __filename = fileURLToPath(import.meta.url);
const __dirname = path.dirname(__filename);
const app = express();
const PORT = process.env.API_PORT || 3001;
// Enable CORS for all origins
app.use(cors({
origin: '*',
methods: ['GET', 'POST', 'PUT', 'DELETE', 'OPTIONS'],
allowedHeaders: ['Content-Type', 'Authorization']
}));
app.use(express.json());
// Logging middleware
app.use((req, res, next) => {
console.log(`[${new Date().toISOString()}] ${req.method} ${req.url}`);
next();
});
// Health check endpoint
app.get('/health', (req, res) => {
res.json({
status: 'ok',
timestamp: new Date().toISOString(),
services: {
api: 'running',
vitepress: 'running'
}
});
});
// Export PDF endpoint
app.get('/export-pdf', async (req, res) => {
const docsPath = process.env.DOCS_PATH || '/app/docs';
const pdfFileName = req.query.fileName || `export-${Date.now()}.pdf`;
const vitepressPort = process.env.VITEPRESS_PORT || 3000;
console.log(`[${new Date().toISOString()}] Starting PDF export...`);
console.log(`Docs path: ${docsPath}`);
console.log(`PDF output: ${path.join(docsPath, pdfFileName)}`);
console.log(`VitePress port: ${vitepressPort}`);
try {
// Ensure PDF directory exists
await fs.ensureDir(docsPath);
// Clean old dist directory
const distDir = path.join(docsPath, '.vitepress', 'dist');
console.log('Cleaning old dist directory...');
await fs.remove(distDir).catch(() => {});
// Build the VitePress site
/*
console.log('Building VitePress site...');
try {
await execAsync('npm run docs:build', {
cwd: '/app',
stdio: 'inherit',
timeout: 120000 // 2 minutes timeout
});
} catch (buildError) {
console.error('Build warning/error:', buildError.message);
// Continue anyway, sometimes there are non-fatal warnings
}
*/
// Run PDF export (VitePress preview is already running)
console.log('Starting PDF export using running VitePress server...');
const exportEnv = {
...process.env,
NODE_ENV: 'development'
};
try {
/*
console.log('Installing vitepress-export-pdf...');
await execAsync('npm install vitepress-export-pdf -D', {
cwd: '/app',
stdio: 'inherit',
env: exportEnv,
timeout: 120000
});
*/
console.log('Running export-pdf...');
await execAsync('npm run export-pdf', {
cwd: '/app',
stdio: 'inherit',
env: exportEnv,
timeout: 180000,
maxBuffer: 1024 * 1024 * 100
});
} catch (exportError) {
console.error('Export command failed:', exportError.message);
throw new Error(`PDF export failed: ${exportError.message}`);
}
// Verify PDF was created
const pdfPath = path.join(docsPath, pdfFileName);
const pdfExists = await fs.pathExists(pdfPath);
if (!pdfExists) {
// Try to find any PDF file in the directory
const files = await fs.readdir(docsPath);
const pdfFiles = files.filter(f => f.endsWith('.pdf'));
if (pdfFiles.length > 0) {
console.log(`PDF found with different name: ${pdfFiles[0]}`);
const stats = await fs.stat(path.join(docsPath, pdfFiles[0]));
console.log(`[${new Date().toISOString()}] PDF export completed successfully!`);
console.log(`PDF size: ${(stats.size / 1024 / 1024).toFixed(2)} MB`);
return res.json({
success: true,
message: 'PDF exported successfully',
pdfPath: path.join(docsPath, pdfFiles[0]),
pdfUrl: `${pdfFiles[0]}`,
fileName: pdfFiles[0],
fileSize: stats.size,
fileSizeMB: (stats.size / 1024 / 1024).toFixed(2)
});
} else {
throw new Error('PDF file was not created');
}
}
const stats = await fs.stat(pdfPath);
console.log(`[${new Date().toISOString()}] PDF export completed successfully!`);
console.log(`PDF path: ${pdfPath}`);
console.log(`PDF size: ${(stats.size / 1024 / 1024).toFixed(2)} MB`);
res.json({
success: true,
message: 'PDF exported successfully',
pdfPath: pdfPath,
pdfUrl: `${pdfFileName}`,
fileName: pdfFileName,
fileSize: stats.size,
fileSizeMB: (stats.size / 1024 / 1024).toFixed(2)
});
} catch (error) {
console.error(`[${new Date().toISOString()}] PDF export failed:`, error);
res.status(500).json({
success: false,
error: error.message,
stack: process.env.NODE_ENV === 'development' ? error.stack : undefined
});
}
});
// List all PDF files
app.get('/pdf-files', async (req, res) => {
const docsPath = process.env.DOCS_PATH || '/app/docs';
try {
await fs.ensureDir(docsPath);
const files = await fs.readdir(docsPath);
const pdfFiles = files.filter(f => f.endsWith('.pdf'));
const fileDetails = await Promise.all(
pdfFiles.map(async (file) => {
const stats = await fs.stat(path.join(docsPath, file));
return {
name: file,
size: stats.size,
sizeMB: (stats.size / 1024 / 1024).toFixed(2),
created: stats.birthtime,
modified: stats.mtime
};
})
);
res.json({
count: pdfFiles.length,
files: fileDetails
});
} catch (error) {
res.status(500).json({ error: error.message });
}
});
// Error handling middleware
app.use((err, req, res, next) => {
console.error(`[${new Date().toISOString()}] Error:`, err);
res.status(500).json({
error: err.message || 'Internal server error',
stack: process.env.NODE_ENV === 'development' ? err.stack : undefined
});
});
app.listen(PORT, '0.0.0.0', () => {
console.log(`========================================`);
console.log(`VitePress API Server`);
console.log(`========================================`);
console.log(`API Server running on port: ${PORT}`);
console.log(`VitePress Server: http://localhost:${process.env.VITEPRESS_PORT || 3000}`);
console.log(`PDF output directory: ${process.env.DOCS_PATH || '/app/docs'}`);
console.log(`========================================`);
console.log(`Available API endpoints:`);
console.log(` GET /health - Health check`);
console.log(` GET /export-pdf - Export PDF`);
console.log(` GET /pdf-files - List all PDF files`);
console.log(`========================================`);
});

84
docker/docker-entrypoint.sh Normal file
View File

@@ -0,0 +1,84 @@
#!/bin/sh
set -e
echo "========================================"
echo "VitePress Container"
echo "========================================"
# Set default values
export DOCS_PATH=${DOCS_PATH:-/app/docs}
export VITEPRESS_PORT=${VITEPRESS_PORT:-3000}
export API_PORT=${API_PORT:-3001}
echo "Configuration:"
echo " DOCS_PATH: $DOCS_PATH"
echo " VITEPRESS_PORT: $VITEPRESS_PORT"
echo " API_PORT: $API_PORT"
echo "========================================"
# Check if docs directory exists
if [ ! -d "$DOCS_PATH" ]; then
echo "Creating docs directory: $DOCS_PATH"
mkdir -p "$DOCS_PATH"
fi
# Check if package.json exists
if [ ! -f "/app/package.json" ]; then
echo "Error: /app/package.json not found!"
exit 1
fi
# Install API dependencies if needed
if [ ! -f "/app/api/node_modules/.package-lock.json" ]; then
echo "Installing API dependencies..."
cd /app/api && npm install
fi
echo ""
echo "========================================"
echo "Starting VitePress Documentation Server..."
echo "========================================"
# Start VitePress dev server in background (运行在 docs 目录下)
echo "[1/2] Starting VitePress dev server on port $VITEPRESS_PORT..."
cd /app
export NODE_ENV=development
nohup npm run docs:dev -- --port $VITEPRESS_PORT --host > /var/log/vitepress.log 2>&1 &
VITEPRESS_PID=$!
echo "VitePress started with PID: $VITEPRESS_PID"
# export NODE_ENV=development
# npm run docs:dev -- --port $VITEPRESS_PORT --host
# Wait for VitePress to start
echo "Waiting for VitePress to start..."
sleep 10
# Check if VitePress is running
if ! kill -0 $VITEPRESS_PID 2>/dev/null; then
echo "Warning: VitePress server may not have started properly"
echo "Check logs: cat /var/log/vitepress.log"
fi
echo "[2/2] Starting API server on port $API_PORT..."
echo ""
echo "========================================"
echo "All services started successfully!"
echo "========================================"
echo ""
echo "Services:"
echo " - VitePress Documentation: http://localhost:$VITEPRESS_PORT"
echo " - API Server: http://localhost:$API_PORT"
echo ""
echo "API Endpoints:"
echo " GET /health - Health check"
echo " GET /export-pdf - Export PDF"
echo "Logs:"
echo " VitePress: cat /var/log/vitepress.log"
echo " API Server: docker logs vitepress-docker"
echo ""
echo "========================================"
# Execute the API server with absolute path
exec node /app/api/server.js

219
docs/.vitepress/config.mjs Normal file
View File

@@ -0,0 +1,219 @@
import { defineConfig } from 'vitepress'
import { withMermaid } from 'vitepress-plugin-mermaid'
import mathjax3 from 'markdown-it-mathjax3'
export default withMermaid(
defineConfig({
title: 'HF-MES v5.0 使用手册',
description: 'HF-MES v5.0 制造执行系统完整使用指南',
lang: 'zh-CN',
themeConfig: {
logo: '/logo.svg',
siteTitle: 'HF-MES v5.0 使用手册',
nav: [
{ text: '首页', link: '/' },
{
text: '文档说明',
items: [
{ text: '文档说明', link: '/guide/document-guide' },
{ text: '系统概述', link: '/guide/system-overview' }
]
},
{
text: '快速入门',
items: [
{ text: '快速入门', link: '/getting-started/quick-start' }
]
},
{
text: '基础配置',
items: [
{ text: '基础数据管理', link: '/basic/data-management' },
{ text: '设备管理', link: '/basic/equipment' }
]
},
{
text: '业务模块',
items: [
{ text: '生产管理', link: '/business/production' },
{ text: '质量管理', link: '/business/quality' },
{ text: '仓储物流', link: '/business/warehouse' },
{ text: '设备仓储', link: '/business/equipment-warehouse' }
]
},
{
text: '数据集成',
items: [
{ text: '数据与集成', link: '/integration/data-integration' }
]
},
{
text: '报表分析',
items: [
{ text: '报表与分析', link: '/analysis/reports' }
]
},
{
text: '系统运维',
items: [
{ text: '系统运维', link: '/operation/system-operation' },
{ text: '技术支持', link: '/operation/technical-support' }
]
},
{
text: '附录',
items: [
{ text: '术语表', link: '/appendix/glossary' }
]
}
],
sidebar: {
'/guide/': [
{
text: '文档管理篇',
items: [
{ text: '文档说明', link: '/guide/document-guide' }
]
},
{
text: '系统认知篇',
items: [
{ text: '系统概述', link: '/guide/system-overview' }
]
}
],
'/getting-started/': [
{
text: '快速入门篇',
items: [
{ text: '快速入门', link: '/getting-started/quick-start' }
]
}
],
'/basic/': [
{
text: '基础配置篇',
items: [
{ text: '基础数据管理', link: '/basic/data-management' },
{ text: '设备基础信息', link: '/basic/equipment' }
]
}
],
'/business/': [
{
text: '生产管理篇',
items: [
{ text: '生产管理', link: '/business/production' }
]
},
{
text: '质量管理篇',
items: [
{ text: '质量与追溯', link: '/business/quality' }
]
},
{
text: '仓储物流篇',
items: [
{ text: '设备与仓储', link: '/business/equipment-warehouse' }
]
}
],
'/integration/': [
{
text: '数据集成篇',
items: [
{ text: '数据与集成', link: '/integration/data-integration' }
]
}
],
'/analysis/': [
{
text: '报表分析篇',
items: [
{ text: '报表与分析', link: '/analysis/reports' }
]
}
],
'/operation/': [
{
text: '系统运维篇',
items: [
{ text: '系统运维', link: '/operation/system-operation' }
]
},
{
text: '技术支持篇',
items: [
{ text: '异常处理与技术支持', link: '/operation/technical-support' }
]
}
],
'/appendix/': [
{
text: '附录篇',
items: [
{ text: '术语表', link: '/appendix/glossary' }
]
}
]
},
socialLinks: [
{ icon: 'github', link: 'https://github.com/vuejs/vitepress' }
],
footer: {
message: 'HF-MES v5.0 使用手册',
copyright: 'Copyright © 2026 All Rights Reserved'
},
search: {
provider: 'local'
},
editLink: {
pattern: 'https://github.com/vuejs/vitepress/edit/main/docs/:path',
text: '在 GitHub 上编辑此页'
},
lastUpdated: {
text: '最后更新于',
formatOptions: {
dateStyle: 'short',
timeStyle: 'short'
}
},
outline: {
level: [2, 3],
label: '目录'
},
docFooter: {
prev: '← 上一页',
next: '下一页 →'
}
},
markdown: {
theme: {
light: 'github-light',
dark: 'github-dark'
},
lineNumbers: false,
config(md) {
md.use(mathjax3)
}
},
head: [
['link', { rel: 'icon', href: '/favicon.ico' }],
['meta', { name: 'author', content: 'HF-MES' }],
['meta', { name: 'viewport', content: 'width=device-width, initial-scale=1.0' }]
]
})
)

11
docs/.vitepress/public/logo.svg Normal file
View File

@@ -0,0 +1,11 @@
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 100 100" width="100" height="100">
<defs>
<linearGradient id="grad1" x1="0%" y1="0%" x2="100%" y2="100%">
<stop offset="0%" style="stop-color:#3b82f6;stop-opacity:1" />
<stop offset="100%" style="stop-color:#1e40af;stop-opacity:1" />
</linearGradient>
</defs>
<circle cx="50" cy="50" r="45" fill="url(#grad1)"/>
<text x="50" y="58" font-family="Arial, sans-serif" font-size="36" font-weight="bold" fill="white" text-anchor="middle">MES</text>
<text x="50" y="75" font-family="Arial, sans-serif" font-size="12" fill="white" text-anchor="middle">v5.0</text>
</svg>
Side by Side

After

Width:  |  Height:  |  Size: 646 B

13
docs/.vitepress/theme/index.ts Normal file
View File

@@ -0,0 +1,13 @@
import DefaultTheme from 'vitepress/theme'
import mediumZoom from 'medium-zoom'
import { onMounted } from 'vue'
import './style/print.css'
export default {
...DefaultTheme,
setup() {
onMounted(() => {
mediumZoom('.main img')
})
}
}

101
docs/.vitepress/theme/style/print.css Normal file
View File

@@ -0,0 +1,101 @@
@media print {
.VPNav,
.VPNavBar,
.VPLocalNav,
.VPDocFooter,
.VPDocAside,
.VPLink,
.cur,
.next-link,
.prev-link,
.edit-link-button,
.pager,
.vp-doc-footer,
.table-of-contents {
display: none !important;
}
body {
font-size: 12pt;
line-height: 1.6;
color: #333;
font-family: "Microsoft YaHei", "微软雅黑", "Microsoft YaHei UI", "PingFang SC", "Hiragino Sans GB", "Noto Sans CJK SC", "Source Han Sans CN", "WenQuanYi Micro Hei", "Heiti SC", sans-serif;
-webkit-font-smoothing: antialiased;
-moz-osx-font-smoothing: grayscale;
}
h1 {
font-size: 24pt;
page-break-after: avoid;
margin-bottom: 20pt;
font-family: "Microsoft YaHei", "微软雅黑", "Microsoft YaHei UI", "PingFang SC", "Hiragino Sans GB", "Noto Sans CJK SC", "Source Han Sans CN", "WenQuanYi Micro Hei", "Heiti SC", sans-serif;
}
h2 {
font-size: 18pt;
page-break-after: avoid;
margin-top: 20pt;
margin-bottom: 10pt;
font-family: "Microsoft YaHei", "微软雅黑", "Microsoft YaHei UI", "PingFang SC", "Hiragino Sans GB", "Noto Sans CJK SC", "Source Han Sans CN", "WenQuanYi Micro Hei", "Heiti SC", sans-serif;
}
h3 {
font-size: 14pt;
page-break-after: avoid;
margin-top: 15pt;
margin-bottom: 8pt;
font-family: "Microsoft YaHei", "微软雅黑", "Microsoft YaHei UI", "PingFang SC", "Hiragino Sans GB", "Noto Sans CJK SC", "Source Han Sans CN", "WenQuanYi Micro Hei", "Heiti SC", sans-serif;
}
p, li, td, th {
font-family: "Microsoft YaHei", "微软雅黑", "Microsoft YaHei UI", "PingFang SC", "Hiragino Sans GB", "Noto Sans CJK SC", "Source Han Sans CN", "WenQuanYi Micro Hei", "Heiti SC", sans-serif;
}
table {
font-size: 10pt;
page-break-inside: avoid;
font-family: "Microsoft YaHei", "微软雅黑", "Microsoft YaHei UI", "PingFang SC", "Hiragino Sans GB", "Noto Sans CJK SC", "Source Han Sans CN", "WenQuanYi Micro Hei", "Heiti SC", sans-serif;
}
img {
max-width: 100%;
page-break-inside: avoid;
}
pre {
page-break-inside: avoid;
}
.vp-doc div[class*="language-"] {
background: #f6f8fa;
border: 1px solid #e1e4e8;
border-radius: 6px;
padding: 16px;
overflow-x: auto;
page-break-inside: avoid;
}
.vp-doc div[class*="language-"] code {
font-family: Consolas, Monaco, 'Andale Mono', monospace;
font-size: 9pt;
line-height: 1.45;
}
a {
color: #0366d6;
text-decoration: none;
}
.vp-doc h1,
.vp-doc h2,
.vp-doc h3 {
border-bottom: 1px solid #eaecef;
padding-bottom: 0.3em;
}
* {
-webkit-print-color-adjust: exact !important;
print-color-adjust: exact !important;
color-adjust: exact !important;
}
}

94
docs/.vitepress/vitepress-pdf.config.ts Normal file
View File

@@ -0,0 +1,94 @@
import { defineUserConfig } from 'vitepress-export-pdf'
import userConfig from './config.mjs'
function extractLinksFromConfig(config: DefaultTheme.Config) {
const links: string[] = []
function extractLinks(sidebar: DefaultTheme.SidebarItem[]) {
for (const item of sidebar) {
if (item.items)
extractLinks(item.items)
else if (item.link)
links.push(`${item.link}.html`)
}
}
for (const key in config.sidebar)
extractLinks(config.sidebar[key])
return links
}
const links = extractLinksFromConfig(userConfig.themeConfig!)
export default defineUserConfig({
sorter: (pageA, pageB) => {
const routeOrder = [
'/index.html',
...links,
]
const aIndex = routeOrder.findIndex(route => route === pageA.path)
const bIndex = routeOrder.findIndex(route => route === pageB.path)
if (aIndex === -1 && bIndex === -1) {
return pageA.path.localeCompare(pageB.path)
}
if (aIndex === -1) return 1
if (bIndex === -1) return -1
return aIndex - bIndex
},
outFile: 'HF-MES-v5.0-使用手册.pdf',
outDir: 'docs',
routePatterns: ['/**'],
pdfOptions: {
format: 'A4',
margin: {
top: '20mm',
right: '15mm',
bottom: '20mm',
left: '15mm'
},
printBackground: true,
preferCSSPageSize: true,
displayHeaderFooter: true,
headerTemplate: `
<div style="font-size: 10px; width: 100%; text-align: center; color: #666; font-family: 'Microsoft YaHei', '微软雅黑', 'Microsoft YaHei UI', 'PingFang SC', sans-serif;">
<span class="title"></span>
</div>
`,
footerTemplate: `
<div style="font-size: 10px; width: 100%; display: flex; justify-content: space-between; padding: 0 15mm; font-family: 'Microsoft YaHei', '微软雅黑', 'Microsoft YaHei UI', 'PingFang SC', sans-serif;">
<span>HF-MES v5.0 使用手册</span>
<span><span class="pageNumber"></span> / <span class="totalPages"></span></span>
</div>
`
},
pdfOutlines: true,
puppeteerLaunchOptions: {
headless: true,
timeout: 60000,
args: [
'--no-sandbox',
'--disable-setuid-sandbox',
'--disable-dev-shm-usage',
'--disable-gpu',
'--disable-software-rasterizer',
'--no-first-run',
'--no-zygote',
'--single-process',
'--font-render-hinting=none',
'--disable-font-subpixel-positioning',
'--force-color-profile=srgb',
],
env: {
FC_LANG: 'zh-CN',
LANG: 'zh_CN.UTF-8',
LC_ALL: 'zh_CN.UTF-8',
},
dumpio: false,
}
})

380
docs/analysis/reports.md Normal file
View File

@@ -0,0 +1,380 @@
# 报表与分析
## 1. 功能概述
报表与分析模块提供丰富的统计分析报表，帮助企业洞察生产运营情况，辅助管理层决策。
**核心功能：**
| 功能 | 说明 |
|------|------|
| 生产报表 | 生产数据统计分析 |
| 质量报表 | 质量数据统计分析 |
| 设备报表 | 设备运行数据分析 |
| 库存报表 | 库存数据分析 |
| 报表定制 | 自定义报表开发 |
| 报表订阅 | 报表自动推送 |
## 2. 生产报表
### 2.1 生产日报
**报表内容：**
| 统计项 | 说明 |
|--------|------|
| 日期 | 统计日期 |
| 产线 | 产线名称 |
| 计划产量 | 当日计划生产数量 |
| 实际产量 | 当日实际生产数量 |
| 达成率 | 实际/计划×100% |
| 合格数量 | 合格品数量 |
| 合格率 | 合格/实际×100% |
| 不良数量 | 不良品数量 |
| 不良率 | 不良/实际×100% |
| 在制数量 | 当日在制品数量 |
**报表展示示例：**
```
┌─────────────────────────────────────────────────────────────┐
│ 生产日报 - 2026-04-10 │
├─────────────────────────────────────────────────────────────┤
│ │
│ SMT-A线 │
│ ┌──────────┬──────────┬──────────┬──────────┬──────────┐ │
│ │ 计划产量 │ 实际产量 │ 达成率 │ 合格率 │ 不良率 │ │
│ │ 10000 │ 9520 │ 95.2% │ 98.5% │ 1.5% │ │
│ └──────────┴──────────┴──────────┴──────────┴──────────┘ │
│ │
│ SMT-B线 │
│ ┌──────────┬──────────┬──────────┬──────────┬──────────┐ │
│ │ 8000 │ 7600 │ 95.0% │ 98.2% │ 1.8% │ │
│ └──────────┴──────────┴──────────┴──────────┴──────────┘ │
│ │
└─────────────────────────────────────────────────────────────┘
```
### 2.2 生产月报
**报表内容：**
| 统计项 | 说明 |
|--------|------|
| 月份 | 统计月份 |
| 部门 | 部门名称 |
| 产品 | 产品名称 |
| 计划产量 | 月度计划数量 |
| 完成产量 | 月度完成数量 |
| 计划达成率 | 完成/计划×100% |
| 人均产量 | 产量/人数 |
| 设备利用率 | 设备运行时间/可用时间 |
### 2.3 工单统计
**统计维度：**
| 维度 | 说明 |
|------|------|
| 工单数量 | 已完成/进行中/已取消 |
| 工单准时率 | 按时完成工单/总工单 |
| 工单超期率 | 超期工单/总工单 |
| 工单变更率 | 变更工单/总工单 |
### 2.4 产能分析
**分析内容：**
| 分析项 | 说明 |
|--------|------|
| 产能利用率 | 实际产能/理论产能 |
| 产能瓶颈 | 影响产能的工序/设备 |
| 产能提升空间 | 优化后可提升空间 |
| 产能预测 | 未来产能预测 |
**产能分析表：**
| 产线 | 理论产能 | 实际产能 | 利用率 | 瓶颈工序 |
|------|---------|---------|--------|---------|
| SMT-A | 25000 | 21250 | 85.0% | 回流焊接 |
| SMT-B | 20000 | 17000 | 85.0% | AOI检测 |
| 组装-A | 15000 | 12000 | 80.0% | 组装 |
## 3. 质量报表
### 3.1 质量日报
**报表内容：**
| 统计项 | 说明 |
|--------|------|
| 日期 | 统计日期 |
| 检验类型 | IQC/IPQC/FQC |
| 检验批次 | 检验批次数量 |
| 合格批次 | 合格批次数量 |
| 批次合格率 | 合格/总批次×100% |
| 检验数量 | 检验数量 |
| 合格数量 | 合格数量 |
| 单件合格率 | 合格/检验×100% |
| 主要不良 | 主要不良类型 |
### 3.2 质量月报
**报表内容：**
| 统计项 | 说明 |
|--------|------|
| 月份 | 统计月份 |
| IQC批次合格率 | 来料检验批次合格率 |
| IPQC合格率 | 过程检验合格率 |
| FQC合格率 | 最终检验合格率 |
| 客户投诉数 | 客户质量投诉次数 |
| 质量成本 | 质量损失成本 |
| 质量目标达成 | 实际/目标×100% |
### 3.3 不良品分析
**分析维度：**
| 分析类型 | 分析内容 |
|---------|---------|
| 不良项目分析 | 各种不良类型占比 |
| 不良工序分析 | 各工序不良分布 |
| 不良时段分析 | 不良发生时段分布 |
| 不良原因分析 | 不良原因占比 |
| 不良趋势分析 | 不良率变化趋势 |
**不良柏拉图分析：**
| 不良类型 | 数量 | 占比 | 累计占比 |
|---------|------|------|---------|
| 外观不良 | 150 | 30% | 30% |
| 尺寸不良 | 120 | 24% | 54% |
| 功能不良 | 100 | 20% | 74% |
| 性能不良 | 80 | 16% | 90% |
| 其他不良 | 50 | 10% | 100% |
### 3.4 质量趋势分析
**趋势分析：**
| 分析项 | 展示方式 |
|--------|---------|
| 合格率趋势 | 折线图 |
| 不良率趋势 | 折线图 |
| 目标达成趋势 | 对比图 |
| SPC控制图 | 控制图 |
## 4. 设备报表
### 4.1 设备运行日报
**报表内容：**
| 统计项 | 说明 |
|--------|------|
| 日期 | 统计日期 |
| 设备编号 | 设备编码 |
| 设备名称 | 设备名称 |
| 运行时间 | 实际运行小时 |
| 停机时间 | 停机小时数 |
| 运行率 | 运行/可用×100% |
| 故障次数 | 故障次数 |
| 维护次数 | 维护次数 |
| OEE | 设备综合效率 |
### 4.2 OEE分析报表
**OEE组成分析：**
| OEE组成 | 说明 | 计算公式 |
|--------|------|---------|
| 可用率 | 时间利用率 | 运行时间/计划时间 |
| 性能率 | 速度利用率 | 实际产出/理论产出 |
| 合格率 | 质量利用率 | 合格数/总产出 |
| OEE | 综合效率 | 可用率×性能率×合格率 |
**OEE分析表：**
| 设备 | 可用率 | 性能率 | 合格率 | OEE |
|------|--------|--------|--------|-----|
| 贴片机-A | 95% | 90% | 98% | 83.8% |
| 回流焊-B | 92% | 88% | 99% | 80.1% |
| AOI-C | 98% | 85% | 97% | 80.9% |
### 4.3 设备维护报表
**维护统计：**
| 统计项 | 说明 |
|--------|------|
| 设备编号 | 设备编码 |
| 点检次数 | 点检执行次数 |
| 保养次数 | 保养执行次数 |
| 故障次数 | 故障发生次数 |
| 维修时间 | 总维修时间 |
| MTBF | 平均故障间隔时间 |
| MTTR | 平均维修时间 |
| 维护成本 | 维护费用 |
## 5. 库存报表
### 5.1 库存台账
**报表内容：**
| 统计项 | 说明 |
|--------|------|
| 物料编码 | 物料编号 |
| 物料名称 | 物料名称 |
| 仓库 | 仓库名称 |
| 库位 | 库位编码 |
| 批次 | 物料批次 |
| 数量 | 库存数量 |
| 单位 | 计量单位 |
| 金额 | 库存金额 |
| 库存状态 | 正常/冻结 |
### 5.2 库存周转分析
**周转指标：**
| 指标 | 计算公式 | 说明 |
|------|---------|------|
| 库存周转率 | 出库成本/平均库存 | 周转次数 |
| 库存周转天数 | 360/周转率 | 周转天数 |
| 库存周转率目标 | - | 目标值 |
**分析表：**
| 物料类别 | 平均库存 | 月出库 | 周转率 | 周转天数 |
|---------|---------|--------|--------|---------|
| 原材料 | 100万 | 50万 | 6次 | 60天 |
| 半成品 | 80万 | 40万 | 6次 | 60天 |
| 成品 | 120万 | 60万 | 6次 | 60天 |
### 5.3 呆滞物料分析
**呆滞定义：**
| 呆滞等级 | 定义 | 说明 |
|---------|------|------|
| 一级呆滞 | 6个月未使用 | 需处理 |
| 二级呆滞 | 3-6个月未使用 | 关注 |
| 三级呆滞 | 1-3个月未使用 | 预警 |
**呆滞物料表：**
| 物料编码 | 物料名称 | 库存数量 | 呆滞时长 | 库存金额 | 处理建议 |
|---------|---------|---------|---------|---------|---------|
| M001 | 电阻10K | 50000 | 8个月 | 5万 | 促销/报废 |
| M002 | 电容100u | 30000 | 7个月 | 3万 | 促销/转用 |
## 6. 报表管理
### 6.1 报表分类
| 报表类别 | 说明 | 使用对象 |
|---------|------|---------|
| 日常报表 | 每日生产、质量数据 | 车间主管 |
| 统计报表 | 月度统计数据 | 部门经理 |
| 分析报表 | 深度分析报告 | 高层管理 |
| 自定义报表 | 用户自定义报表 | 根据需求 |
### 6.2 报表导出
**导出格式：**
| 格式 | 说明 | 适用场景 |
|------|------|---------|
| Excel | .xlsx格式 | 数据分析 |
| PDF | PDF格式 | 打印存档 |
| CSV | CSV格式 | 数据导入 |
| Word | .docx格式 | 报告编写 |
### 6.3 报表订阅
**订阅配置：**
| 配置项 | 说明 |
|--------|------|
| 报表名称 | 订阅的报表 |
| 订阅周期 | 每日/每周/每月 |
| 发送时间 | 发送时间点 |
| 接收人 | 接收人邮箱 |
| 发送格式 | Excel/PDF |
## 7. 数据可视化
### 7.1 图表类型
| 图表类型 | 适用场景 |
|---------|---------|
| 折线图 | 趋势分析 |
| 柱状图 | 对比分析 |
| 饼图 | 占比分析 |
| 散点图 | 关联分析 |
| 甘特图 | 进度展示 |
| 仪表盘 | 目标达成展示 |
### 7.2 看板展示
**生产监控看板：**
```
┌─────────────────────────────────────────────────────────────┐
│ 生产监控看板 │
├─────────────────────────────────────────────────────────────┤
│ │
│ ┌─────────────────┐ ┌─────────────────┐ │
│ │ 今日产量 │ │ 达成率 │ │
│ │ 95,520 │ │ 95.5% │ │
│ │ ▲ 3.2% │ │ ▲ 2.1% │ │
│ └─────────────────┘ └─────────────────┘ │
│ │
│ ┌─────────────────┐ ┌─────────────────┐ │
│ │ 合格率 │ │ OEE │ │
│ │ 98.5% │ │ 82.3% │ │
│ │ ▲ 0.3% │ │ ▼ 1.5% │ │
│ └─────────────────┘ └─────────────────┘ │
│ │
│ 产量趋势图： │
│ ┌─────────────────────────────────────────────────────┐ │
│ │ ╱╲ ╱╲ ╱╲ ╱╲ │ │
│ │ ╱╲╱ ╲╱ ╲╱ ╲╱ ╲╱ ╲╱ │ │
│ │──╱────────────────────────────── │ │
│ │ 1 2 3 4 5 6 7 8 9 10 (日期) │ │
│ └─────────────────────────────────────────────────────┘ │
│ │
└─────────────────────────────────────────────────────────────┘
```
## 8. 自定义报表
### 8.1 报表设计
**设计要素：**
| 要素 | 说明 |
|------|------|
| 数据源 | 数据来源表/视图 |
| 查询条件 | 筛选条件 |
| 数据字段 | 显示字段 |
| 计算字段 | 计算公式 |
| 分组汇总 | 分组汇总方式 |
| 排序规则 | 排序方式 |
| 展示样式 | 表格/图表/看板 |
### 8.2 报表权限
| 权限类型 | 说明 |
|---------|------|
| 创建权限 | 新建报表 |
| 编辑权限 | 修改报表 |
| 查看权限 | 查看报表 |
| 删除权限 | 删除报表 |
| 导出权限 | 导出报表 |
---
**报表与分析篇完**

195
docs/appendix/glossary.md Normal file
View File

@@ -0,0 +1,195 @@
# 术语表
## 1. 专业术语定义
### 1.1 MES系统相关术语
| 术语 | 英文全称 | 中文定义 |
|------|---------|---------|
| MES | Manufacturing Execution System | 制造执行系统 |
| ERP | Enterprise Resource Planning | 企业资源计划 |
| WMS | Warehouse Management System | 仓库管理系统 |
| QMS | Quality Management System | 质量管理系统 |
| SCADA | Supervisory Control And Data Acquisition | 数据采集与监控系统 |
| PLC | Programmable Logic Controller | 可编程逻辑控制器 |
| BOM | Bill of Materials | 物料清单 |
| WIP | Work In Process | 在制品 |
| OEE | Overall Equipment Effectiveness | 设备综合效率 |
| SPC | Statistical Process Control | 统计过程控制 |
### 1.2 质量相关术语
| 术语 | 英文全称 | 中文定义 |
|------|---------|---------|
| IQC | Incoming Quality Control | 来料质量控制 |
| IPQC | In-Process Quality Control | 过程质量控制 |
| FQC | Final Quality Control | 最终质量控制 |
| OQC | Outgoing Quality Control | 出货质量控制 |
| MRB | Material Review Board | 物料审核委员会 |
| AQL | Acceptable Quality Level | 允收质量水平 |
| QC | Quality Control | 质量控制 |
| QA | Quality Assurance | 质量保证 |
### 1.3 设备相关术语
| 术语 | 英文全称 | 中文定义 |
|------|---------|---------|
| MTBF | Mean Time Between Failures | 平均故障间隔时间 |
| MTTR | Mean Time To Repair | 平均维修时间 |
| TPM | Total Productive Maintenance | 全面生产维护 |
| TPM | Total Productive Management | 全面生产管理 |
### 1.4 仓储物流相关术语
| 术语 | 英文全称 | 中文定义 |
|------|---------|---------|
| FIFO | First In First Out | 先进先出 |
| RFID | Radio Frequency Identification | 射频识别 |
| SKU | Stock Keeping Unit | 库存单位 |
| WMS | Warehouse Management System | 仓库管理系统 |
### 1.5 系统与技术相关术语
| 术语 | 英文全称 | 中文定义 |
|------|---------|---------|
| API | Application Programming Interface | 应用程序接口 |
| REST | Representational State Transfer | 表述性状态转移 |
| MQTT | Message Queuing Telemetry Transport | 消息队列遥测传输 |
| OPC | OLE for Process Control | 过程控制对象链接与嵌入 |
| RBAC | Role-Based Access Control | 基于角色的访问控制 |
## 2. 业务术语定义
### 2.1 生产管理术语
| 术语 | 定义 |
|------|------|
| 工单 | 生产任务的执行单据，包含生产信息、工艺信息、数量信息 |
| 批次 | 具有相同生产条件的同质产品集合，通过批次号标识 |
| 工序 | 产品生产过程中的具体加工作业步骤 |
| 工艺路线 | 产品从投料到完工所经过的加工顺序 |
| 报工 | 向系统报告生产进度和数量的操作 |
| 完工 | 工序或工单生产完成 |
| 投料 | 将物料投入生产工序 |
| 齐套 | 生产所需的物料、设备、人员等资源准备齐全 |
### 2.2 质量管理术语
| 术语 | 定义 |
|------|------|
| 追溯 | 追踪产品从原材料到成品的全过程信息 |
| 不良品 | 不符合质量标准的产品 |
| 返工 | 将不良品返回工序重新加工 |
| 降级 | 降低产品等级使用 |
| 让步接收 | 经审批后特殊放行 |
| 首件检验 | 每批次开始生产时的第一件产品检验 |
| 巡检 | 生产过程中的定期巡查检验 |
| 抽检 | 按抽样方案进行的随机抽样检验 |
### 2.3 设备管理术语
| 术语 | 定义 |
|------|------|
| 点检 | 对设备进行的日常检查维护 |
| 保养 | 设备的预防性维护活动 |
| 故障 | 设备无法正常运行的异常状态 |
| 维修 | 修复设备故障的活动 |
| OEE | 设备综合效率，反映设备实际生产能力 |
### 2.4 仓储管理术语
| 术语 | 定义 |
|------|------|
| 入库 | 物料进入仓库的操作 |
| 出库 | 物料离开仓库的操作 |
| 库存 | 仓库中存储的物料数量 |
| 库位 | 仓库中物料存放的具体位置 |
| 盘点 | 对仓库物料进行清点的操作 |
| 呆滞 | 长期未使用的物料 |
## 3. 缩略语索引
| 缩略语 | 全称 |
|--------|------|
| WO | Work Order（工单） |
| LOT | Lot（批次） |
| EQ | Equipment（设备） |
| WH | Warehouse（仓库） |
| UPH | Units Per Hour（小时产能） |
| KPI | Key Performance Indicator（关键绩效指标） |
| SLA | Service Level Agreement（服务级别协议） |
| ROI | Return on Investment（投资回报率） |
| BOM | Bill of Materials（物料清单） |
| ERP | Enterprise Resource Planning（企业资源计划） |
## 4. 流程图汇总
### 4.1 生产主流程
```
订单接收 → 计划制定 → 工单生成 → 工单下发
↓
┌──────────────┐
│ 生产执行 │
│ 领料→投料→报工→工序流转 │
└──────────────┘
↓
完工入库 → 质检入库 → 客户交付
```
### 4.2 质量管理流程
```
来料到货 → IQC检验 → 物料入库
↓
┌────────────────────┐
│ 质量管理 │
│ 首件→巡检→抽检→末件 │
└────────────────────┘
↓
成品检验 → 出货检验 → 客户交付
```
### 4.3 设备管理流程
```
设备入账 → 设备运行 → 日常点检 → 计划保养 → 故障维修 → 设备报废
```
### 4.4 仓储物流流程
```
入库流程：到货 → 创建入库单 → IQC检验 → 分配库位 → 上架确认
出库流程：领料申请 → 审核 → 备料 → 扫描出库 → 投料生产
```
## 5. 版本更新日志
### 5.1 版本历史
| 版本号 | 发布日期 | 更新类型 | 更新内容 |
|--------|---------|---------|---------|
| v5.0 | 2026-04-10 | 正式发布 | 初始版本发布，包含完整功能模块 |
### 5.2 更新类型说明
| 更新类型 | 说明 |
|---------|------|
| 新增 | 新增功能 |
| 优化 | 功能优化 |
| 修复 | Bug修复 |
| 变更 | 功能变更 |
## 6. 文档信息
| 文档属性 | 信息 |
|---------|------|
| 文档名称 | HF-MES v5.0 使用手册 |
| 文档版本 | v1.0 |
| 发布日期 | 2026-04-10 |
| 所属公司 | - |
| 文档状态 | 正式发布 |
---
**术语表完**

397
docs/basic/data-management.md Normal file
View File

@@ -0,0 +1,397 @@
# 基础数据管理
## 1. 功能概述
基础数据是 MES 系统运行的核心支撑，涵盖产品、物料、工艺、设备、组织等各类主数据的管理。完善的基础数据是系统正常运转的前提。
**核心数据分类：**
| 数据类别 | 主要内容 | 重要性 |
|---------|---------|--------|
| 产品数据 | 产品信息、BOM、工艺路线 | ⭐⭐⭐⭐⭐ |
| 物料数据 | 物料主数据、单位转换 | ⭐⭐⭐⭐⭐ |
| 工艺数据 | 工序定义、工艺路线 | ⭐⭐⭐⭐ |
| 设备数据 | 设备台账、产线信息 | ⭐⭐⭐⭐ |
| 组织数据 | 工厂、车间、仓库 | ⭐⭐⭐⭐⭐ |
## 2. 产品数据管理
### 2.1 产品主数据
**产品信息定义：**
| 字段 | 说明 | 是否必填 |
|------|------|---------|
| 产品编码 | 产品唯一标识 | ✓ |
| 产品名称 | 产品名称 | ✓ |
| 产品规格 | 产品规格型号 | ✓ |
| 产品分类 | 产品类别 | ✓ |
| 计量单位 | 默认计量单位 | ✓ |
| 产品版本 | 版本号 | - |
| 保质期 | 保质天数 | - |
| 追溯要求 | 是否需要批次追溯 | ✓ |
**产品创建步骤：**
1. 进入【基础数据】→【产品管理】
2. 点击【新建】
3. 填写产品基本信息
4. 保存产品信息
### 2.2 物料清单（BOM）
BOM（Bill of Materials）是产品的物料构成清单，是生产计划、物料核算的基础。
**BOM结构类型：**
| 类型 | 说明 | 适用场景 |
|------|------|---------|
| 单层BOM | 仅包含直接下级物料 | 简单产品 |
| 多层BOM | 包含多层级的物料结构 | 复杂装配产品 |
| 工艺BOM | 包含工艺路线信息 | 生产制造 |
| 成本BOM | 包含成本信息 | 成本核算 |
**BOM层级结构示例：**
```
产品A (1个)
├── 物料B (2个)
│ ├── 物料C (3个)
│ └── 物料D (1个)
└── 物料E (5个)
```
**BOM创建步骤：**
1. 进入【基础数据】→【BOM管理】
2. 选择产品
3. 添加下级物料
4. 填写用量和损耗率
5. 保存BOM
**【提示】** BOM变更需要经过审核流程，确保数据准确性。
### 2.3 工艺路线
工艺路线定义产品从原材料到成品的加工顺序和工艺参数。
**工艺路线要素：**
| 要素 | 说明 |
|------|------|
| 工序编号 | 工序唯一标识 |
| 工序名称 | 工序名称 |
| 工序顺序 | 工序执行顺序 |
| 标准工时 | 标准作业时间 |
| 作业指导 | 作业指导书 |
| 检验点 | 是否需要质量检验 |
**工艺路线示例：**
| 工序号 | 工序名称 | 作业工时 | 检验点 | 设备要求 |
|--------|---------|---------|--------|---------|
| 001 | SMT贴片 | 10min | ✓ | SMT设备 |
| 002 | 回流焊接 | 5min | ✓ | 回流焊机 |
| 003 | AOI检测 | 3min | ✓ | AOI设备 |
| 004 | 组装 | 15min | - | 产线 |
| 005 | 测试 | 10min | ✓ | 测试设备 |
| 006 | 包装 | 5min | - | 包装线 |
**工艺路线创建步骤：**
1. 进入【基础数据】→【工艺路线】
2. 选择产品
3. 添加工序
4. 配置工序参数
5. 保存工艺路线
## 3. 物料数据管理
### 3.1 物料主数据
**物料信息字段：**
| 字段 | 说明 | 是否必填 |
|------|------|---------|
| 物料编码 | 物料唯一标识 | ✓ |
| 物料名称 | 物料名称 | ✓ |
| 物料分类 | 物料类别 | ✓ |
| 规格型号 | 物料规格 | ✓ |
| 计量单位 | 计量单位 | ✓ |
| 安全库存 | 最低库存量 | - |
| 最高库存 | 最高库存量 | - |
| 采购周期 | 采购提前期 | - |
| 批次管理 | 是否批次管理 | ✓ |
**物料分类示例：**
| 一级分类 | 二级分类 | 示例 |
|---------|---------|------|
| 原材料 | 金属材料 | 铜材、铝材 |
| 原材料 | 塑料材料 | ABS、PC |
| 半成品 | PCB板 | 单面板、双面板 |
| 半成品 | 结构件 | 外壳、支架 |
| 成品 | 电子元件 | 电阻、电容 |
| 成品 | 模块 | 电源模块、通讯模块 |
| 包材 | 包装材料 | 纸箱、说明书 |
| 辅材 | 化学品 | 焊锡、助焊剂 |
### 3.2 单位管理
**单位类型：**
| 类型 | 说明 | 示例 |
|------|------|------|
| 基本单位 | 最小计量单位 | PCS、KG |
| 采购单位 | 采购计量单位 | 箱、卷 |
| 库存单位 | 库存计量单位 | PCS、KG |
| 生产单位 | 生产投料单位 | 盘、卷 |
**单位转换规则：**
| 物料 | 基本单位 | 采购单位 | 转换比例 |
|------|---------|---------|---------|
| 电阻 | PCS | 盘 | 5000 PCS/盘 |
| 焊锡 | KG | 卷 | 1 KG/卷 |
| PCB板 | PCS | 箱 | 50 PCS/箱 |
### 3.3 仓库管理
**仓库信息：**
| 字段 | 说明 |
|------|------|
| 仓库编码 | 仓库唯一标识 |
| 仓库名称 | 仓库名称 |
| 仓库类型 | 原材料库/成品库/半成品库 |
| 地址 | 仓库地址 |
| 管理员 | 仓库负责人 |
**库位管理：**
| 库位编码 | 说明 | 示例 |
|---------|------|------|
| A-01-001 | 区域-货架-层位 | A区01排001位 |
| 立体库位 | 仓库-区-排-层-位 | 01-01-001-01-01 |
**库位规划原则：**
- 按物料类别分区
- 常用物料靠近出入口
- 危险品单独存放
- 批次管理物料分批存放
## 4. 组织数据管理
### 4.1 组织架构
**组织层级：**
```
公司
└── 工厂
└── 车间
└── 产线
└── 工位
```
**组织数据示例：**
| 层级 | 名称 | 编码 |
|------|------|------|
| 公司 | XX电子有限公司 | HQ |
| 工厂 | 深圳工厂 | SZ01 |
| 车间 | SMT车间 | SZ01-SMT |
| 车间 | 组装车间 | SZ01-ASM |
| 产线 | SMT-A线 | SZ01-SMT-A |
| 产线 | SMT-B线 | SZ01-SMT-B |
| 产线 | 组装-A线 | SZ01-ASM-A |
### 4.2 工厂数据
**工厂信息配置：**
| 配置项 | 说明 |
|--------|------|
| 工厂编码 | 工厂唯一标识 |
| 工厂名称 | 工厂名称 |
| 工厂地址 | 工厂地址 |
| 联系方式 | 联系电话 |
| 工作时间 | 上班时间-下班时间 |
| 时区设置 | 时区配置 |
### 4.3 车间数据
**车间信息配置：**
| 配置项 | 说明 |
|--------|------|
| 车间编码 | 车间唯一标识 |
| 车间名称 | 车间名称 |
| 所属工厂 | 上级工厂 |
| 车间类型 | 生产车间/仓储车间 |
| 负责人 | 车间主管 |
| 联系方式 | 联系电话 |
### 4.4 产线数据
**产线信息配置：**
| 配置项 | 说明 |
|--------|------|
| 产线编码 | 产线唯一标识 |
| 产线名称 | 产线名称 |
| 所属车间 | 上级车间 |
| 产线类型 | 专用线/柔性线 |
| 产能 | UPH（每小时产能） |
| 设备列表 | 产线设备 |
**产能配置：**
| 产线 | 日产能 | 月产能 | 利用率 |
|------|--------|--------|--------|
| SMT-A线 | 10000 PCS | 220000 PCS | 85% |
| SMT-B线 | 8000 PCS | 176000 PCS | 80% |
| 组装-A线 | 5000 PCS | 110000 PCS | 75% |
## 5. 客户与供应商数据
### 5.1 客户数据
**客户信息字段：**
| 字段 | 说明 |
|------|------|
| 客户编码 | 客户唯一标识 |
| 客户名称 | 客户名称 |
| 客户类型 | 经销商/终端客户 |
| 联系信息 | 联系人、电话、邮箱 |
| 地址信息 | 送货地址 |
| 信用等级 | 客户信用等级 |
### 5.2 供应商数据
**供应商信息字段：**
| 字段 | 说明 |
|------|------|
| 供应商编码 | 供应商唯一标识 |
| 供应商名称 | 供应商名称 |
| 供应物料 | 供应的物料类别 |
| 联系信息 | 联系人、电话、邮箱 |
| 地址信息 | 公司地址/送货地址 |
| 资质信息 | 营业执照等资质 |
## 6. 数据导入导出
### 6.1 数据导入
**导入流程：**
1. 下载导入模板
2. 填写数据
3. 上传文件
4. 数据校验
5. 导入确认
6. 导入完成
**【注意】** 导入前请仔细阅读模板填写说明，确保数据格式正确。
### 6.2 数据导出
**导出方式：**
| 方式 | 说明 |
|------|------|
| 页面导出 | 在列表页面选择导出 |
| 批量导出 | 按条件批量导出 |
| 接口导出 | 通过API接口导出 |
**导出格式：**
- Excel格式（.xlsx）
- CSV格式（.csv）
- PDF格式（报表）
### 6.3 导入模板字段说明
**产品导入模板：**
| 列名 | 说明 | 示例 |
|------|------|------|
| 产品编码 | 产品唯一编码 | P001 |
| 产品名称 | 产品名称 | PCB板 |
| 规格型号 | 规格型号 | 100*80mm |
| 产品分类 | 产品分类编码 | 03 |
| 计量单位 | 计量单位编码 | 01 |
| 是否追溯 | 是/否 | 是 |
**物料导入模板：**
| 列名 | 说明 | 示例 |
|------|------|------|
| 物料编码 | 物料唯一编码 | M001 |
| 物料名称 | 物料名称 | 电阻 |
| 规格型号 | 规格型号 | 10KΩ |
| 物料分类 | 物料分类编码 | 0101 |
| 计量单位 | 计量单位编码 | 01 |
| 安全库存 | 安全库存数量 | 1000 |
| 是否批次 | 是否批次管理 | 是 |
## 7. 数据校验规则
### 7.1 编码规则
**编码规范：**
| 数据类型 | 编码规则 | 示例 |
|---------|---------|------|
| 产品编码 | P+数字 | P001 |
| 物料编码 | M+数字 | M001 |
| 客户编码 | C+数字 | C001 |
| 供应商编码 | S+数字 | S001 |
| 设备编码 | E+数字 | E001 |
| 工位编码 | W+数字 | W001 |
**【提示】** 建议在实施前制定统一的编码规范，避免后续混乱。
### 7.2 数据校验
**必填校验：**
- 必填字段不能为空
- 编码不能重复
- 数量必须大于0
**格式校验：**
| 字段 | 格式要求 | 示例 |
|------|---------|------|
| 编码 | 字母+数字组合 | P001 |
| 日期 | YYYY-MM-DD | 2026-04-10 |
| 数量 | 正整数或小数 | 100、99.5 |
| 比例 | 0-100之间 | 85.5% |
## 8. 数据权限管理
### 8.1 数据权限级别
| 权限级别 | 说明 | 适用对象 |
|---------|------|---------|
| 公司级 | 可查看所有工厂数据 | 高管 |
| 工厂级 | 可查看所属工厂数据 | 工厂负责人 |
| 车间级 | 可查看所属车间数据 | 车间主管 |
| 产线级 | 可查看所属产线数据 | 产线主管 |
| 个人级 | 只能查看自己的数据 | 普通员工 |
### 8.2 数据权限配置
**配置要点：**
1. 根据用户角色分配数据权限级别
2. 特殊用户可配置例外权限
3. 定期审核权限配置
---
**基础数据管理篇完**

340
docs/basic/equipment.md Normal file
View File

@@ -0,0 +1,340 @@
# 设备基础信息
## 1. 功能概述
设备基础信息管理是 MES 设备管理模块的重要组成部分，涵盖设备台账、设备分类、设备参数等基础数据的管理，为设备的日常运维和监控分析提供数据支撑。
**核心功能：**
| 功能 | 说明 |
|------|------|
| 设备台账 | 设备基本信息管理 |
| 设备分类 | 设备分类体系管理 |
| 设备参数 | 设备技术参数配置 |
| 设备关联 | 设备与产线、工序关联 |
## 2. 设备台账管理
### 2.1 设备基本信息
**设备信息字段：**
| 字段 | 说明 | 是否必填 |
|------|------|---------|
| 设备编码 | 设备唯一标识 | ✓ |
| 设备名称 | 设备名称 | ✓ |
| 设备型号 | 设备型号规格 | ✓ |
| 设备分类 | 设备所属类别 | ✓ |
| 所属产线 | 所属产线 | ✓ |
| 供应商 | 设备供应商 | - |
| 购置日期 | 购置时间 | ✓ |
| 购置金额 | 采购价格 | - |
| 使用部门 | 使用部门 | ✓ |
| 设备状态 | 在用/停用/报废 | ✓ |
### 2.2 设备状态定义
| 状态 | 说明 | 业务场景 |
|------|------|---------|
| 在用 | 正常运行中 | 正常生产使用 |
| 闲置 | 可用但未使用 | 备用设备 |
| 维修中 | 正在维修 | 故障维修 |
| 保养中 | 正在保养 | 计划保养 |
| 停用 | 暂时停用 | 产能调整 |
| 报废 | 已淘汰 | 设备报废 |
### 2.3 设备创建步骤
**操作步骤：**
1. 进入【设备管理】→【设备台账】
2. 点击【新增设备】
3. 填写设备基本信息
4. 上传设备图片（可选）
5. 保存设备信息
6. 设备审核（如需）
**【提示】** 设备编码建议使用统一的编码规则，便于识别和管理。
## 3. 设备分类管理
### 3.1 设备分类体系
**分类层级结构：**
```
设备
├── 生产设备
│ ├── 加工设备
│ │ ├── CNC加工中心
│ │ ├── 车床
│ │ ├── 铣床
│ │ └── 磨床
│ ├── 专用设备
│ │ ├── SMT设备
│ │ ├── 回流焊
│ │ └── AOI检测仪
│ └── 装配设备
│ ├── 自动装配机
│ └── 手工装配台
├── 检测设备
│ ├── 测量设备
│ ├── 测试设备
│ └── 检验设备
├── 辅助设备
│ ├── 空压设备
│ ├── 通风设备
│ └── 配电设备
└── 办公设备
├── 计算机
└── 网络设备
```
### 3.2 分类管理配置
**分类信息：**
| 配置项 | 说明 |
|--------|------|
| 分类编码 | 分类唯一标识 |
| 分类名称 | 分类名称 |
| 上级分类 | 父级分类 |
| 分类级别 | 层级深度 |
| 排序号 | 显示顺序 |
**【提示】** 合理的设备分类有助于设备统计和分析，建议在实施时仔细规划分类体系。
## 4. 设备参数管理
### 4.1 技术参数
**设备技术参数：**
| 参数类别 | 参数项 | 说明 |
|---------|--------|------|
| 基本参数 | 设备型号 | 设备型号 |
| 基本参数 | 制造商 | 生产厂家 |
| 基本参数 | 出厂日期 | 出厂时间 |
| 基本参数 | 序列号 | 出厂序列号 |
| 性能参数 | 额定功率 | kW |
| 性能参数 | 额定电压 | V |
| 性能参数 | 额定电流 | A |
| 性能参数 | 工作压力 | MPa |
| 性能参数 | 产能 | UPH |
| 尺寸参数 | 外形尺寸 | 长×宽×高 |
| 尺寸参数 | 重量 | kg |
### 4.2 运行时参数
**实时监控参数：**
| 参数类型 | 参数项 | 采集方式 |
|---------|--------|---------|
| 运行状态 | 启动/停止 | 自动采集 |
| 运行时间 | 累计运行时间 | 自动累计 |
| 产量数据 | 当班产量 | 自动统计 |
| 报警状态 | 报警信息 | 自动采集 |
| 能耗数据 | 电力消耗 | 自动采集 |
| 温度数据 | 设备温度 | 传感器采集 |
## 5. 设备关联管理
### 5.1 设备与产线关联
**关联关系：**
| 产线 | 设备列表 | 设备数量 |
|------|---------|---------|
| SMT-A线 | 贴片机、回流焊、AOI | 3台 |
| 组装-A线 | 自动装配机、检测仪 | 2台 |
| 包装-A线 | 贴标机、打包机 | 2台 |
**关联配置步骤：**
1. 进入【设备管理】→【设备关联】
2. 选择产线
3. 添加设备
4. 设置设备在产线中的角色
5. 保存关联关系
### 5.2 设备与工序关联
**工序-设备对应关系：**
| 工序 | 使用设备 | 设备数量 |
|------|---------|---------|
| SMT贴片 | 贴片机 | 1台 |
| 回流焊接 | 回流焊 | 1台 |
| AOI检测 | AOI检测仪 | 1台 |
| 组装 | 自动装配机 | 1台 |
| 测试 | 综合测试仪 | 2台 |
### 5.3 设备能力配置
**产能配置：**
| 设备 | 理论产能 | 实际产能 | 产能利用率 |
|------|---------|---------|-----------|
| SMT贴片机 | 25000 CPH | 20000 CPH | 80% |
| 回流焊机 | 30000 CPH | 25000 CPH | 83% |
| AOI检测仪 | 5000 CPH | 4500 CPH | 90% |
## 6. 设备文档管理
### 6.1 设备文档类型
| 文档类型 | 说明 |
|---------|------|
| 使用说明书 | 设备操作手册 |
| 维修手册 | 维修指南 |
| 保养手册 | 保养规范 |
| 电路图纸 | 电气原理图 |
| 机械图纸 | 机械结构图 |
| 合格证书 | 出厂合格证 |
| 验收报告 | 设备验收单 |
### 6.2 文档上传步骤
**操作步骤：**
1. 进入设备详情页面
2. 点击【文档管理】标签
3. 点击【上传文档】
4. 选择文档类型
5. 上传文件
6. 保存文档信息
**【注意】** 文档建议使用 PDF 格式，确保长期可读性。
## 7. 设备位置管理
### 7.1 设备位置信息
**位置配置：**
| 配置项 | 说明 |
|--------|------|
| 所在工厂 | 所属工厂 |
| 所在车间 | 所属车间 |
| 所在区域 | 车间内区域 |
| 具体位置 | 具体位置描述 |
| GPS坐标 | 经纬度坐标（可选） |
### 7.2 设备布局图
**产线设备布局：**
```
产线布局示意图：
入口 ──▶ [来料暂存区]
│
▼
┌────────┐
│ 贴片机 │ ← 设备1
└────┬───┘
│
▼
┌────────┐
│ 回流焊 │ ← 设备2
└────┬───┘
│
▼
┌────────┐
│ AOI检测 │ ← 设备3
└────┬───┘
│
▼
┌────────┐
│ 组装工位 │ ← 工位1
└────┬───┘
│
▼
[成品暂存区] ──▶ 出口
```
## 8. 设备点检标准
### 8.1 点检项目定义
**点检标准内容：**
| 项目 | 说明 |
|------|------|
| 点检编码 | 点检项目唯一标识 |
| 点检名称 | 点检项目名称 |
| 点检周期 | 日/周/月点检 |
| 点检方法 | 视觉/触觉/听觉等 |
| 判断标准 | 正常/异常判定标准 |
| 处理方式 | 异常时的处理方法 |
### 8.2 点检标准示例
**贴片机日点检标准：**
| 点检项目 | 点检方法 | 判断标准 | 异常处理 |
|---------|---------|---------|---------|
| 设备外观 | 视觉检查 | 无破损、变形 | 停机报修 |
| 电源指示 | 观察指示灯 | 绿色正常 | 检查电源 |
| 物料状态 | 视觉检查 | 物料充足 | 补充物料 |
| 吸嘴清洁度 | 视觉检查 | 无杂物、干净 | 清洁吸嘴 |
| 传送带状态 | 运行观察 | 运行平稳 | 调整张力 |
| 润滑状态 | 触觉检查 | 润滑良好 | 补充润滑油 |
## 9. 设备保养标准
### 9.1 保养周期定义
| 保养类型 | 周期 | 内容 |
|---------|------|------|
| 日常保养 | 每日 | 清洁、润滑、检查 |
| 一级保养 | 每周 | 清洁、润滑、调整 |
| 二级保养 | 每月 | 清洁、润滑、紧固 |
| 三级保养 | 每季 | 检查、调整、更换 |
| 项修 | 每半年 | 部分检修 |
| 大修 | 每年 | 全面检修 |
### 9.2 保养标准内容
**保养标准要素：**
| 要素 | 说明 |
|------|------|
| 保养编码 | 保养标准唯一标识 |
| 保养名称 | 保养项目名称 |
| 保养周期 | 执行周期 |
| 保养项目 | 具体保养内容 |
| 所需备件 | 保养所需备件 |
| 预计工时 | 保养预计时间 |
| 保养指导 | 保养操作指导 |
## 10. 数据导入与维护
### 10.1 批量导入
**导入模板字段：**
| 列名 | 说明 | 示例 |
|------|------|------|
| 设备编码 | 唯一编码 | E001 |
| 设备名称 | 设备名称 | SMT贴片机 |
| 设备型号 | 型号规格 | YS-200 |
| 设备分类 | 分类编码 | 0101 |
| 所属产线 | 产线编码 | LINE01 |
| 供应商 | 供应商名称 | XX机械 |
| 购置日期 | 日期格式 | 2025-01-01 |
### 10.2 数据维护规范
**维护要点：**
1. **及时更新** - 设备变更后及时更新信息
2. **定期审核** - 定期审核设备数据准确性
3. **完整记录** - 记录设备全生命周期信息
4. **规范编码** - 遵循统一的编码规范
**【提示】** 设备基础数据的准确性直接影响设备管理效果，建议安排专人负责数据维护。
---
**设备基础信息篇完**

462
docs/business/equipment-warehouse.md Normal file
View File

@@ -0,0 +1,462 @@
# 设备与仓储
## 1. 功能概述
本篇涵盖设备管理和仓储物流两大模块，实现设备的全生命周期管理和物料的仓储物流管理，确保生产过程的顺利进行。
**主要内容包括：**
| 章节 | 主要内容 |
|------|---------|
| 设备管理 | 设备台账、点检保养、故障维修、OEE分析 |
| 仓储物流 | 入库管理、出库管理、库存管理 |
## 2. 设备管理
### 2.1 设备台账
**设备信息管理：**
| 功能 | 说明 |
|------|------|
| 设备登记 | 设备基本信息录入 |
| 设备查询 | 按条件查询设备信息 |
| 设备变更 | 设备信息变更管理 |
| 设备报废 | 设备报废流程处理 |
| 设备文档 | 设备文档资料管理 |
**设备生命周期：**
```
设备采购 → 设备安装 → 设备验收 → 设备运行 → 设备维护 → 设备报废
```
### 2.2 设备点检
**点检类型：**
| 点检类型 | 执行周期 | 执行人员 | 主要内容 |
|---------|---------|---------|---------|
| 日常点检 | 每日 | 操作员 | 设备运行状态检查 |
| 定期点检 | 每周/每月 | 维修员 | 设备性能检查 |
| 精密点检 | 每季/每年 | 工程师 | 设备精度检查 |
**点检流程：**
```
点检计划生成 → 点检任务派发 → 执行点检 → 点检记录 → 异常处理
```
**点检执行步骤：**
1. 接收点检任务
2. 到达设备现场
3. 按照点检标准逐项检查
4. 记录点检结果
5. 提交点检记录
6. 如有异常，触发异常处理流程
**点检记录信息：**
| 记录项 | 说明 |
|--------|------|
| 点检单号 | 点检单唯一标识 |
| 设备编号 | 点检的设备 |
| 点检类型 | 日常/定期/精密 |
| 点检人员 | 执行点检的人员 |
| 点检时间 | 点检时间 |
| 点检项目 | 检查的项目 |
| 点检结果 | 正常/异常 |
| 异常描述 | 异常情况描述 |
### 2.3 设备保养
**保养类型：**
| 保养类型 | 周期 | 内容 | 工时 |
|---------|------|------|------|
| 日常保养 | 每日 | 清洁、润滑、紧固 | 15-30min |
| 一级保养 | 每周 | 清洁、润滑、调整 | 2-4h |
| 二级保养 | 每月 | 清洁、润滑、紧固、更换易损件 | 8h |
| 三级保养 | 每季 | 全方面检查、调整、更换 | 1-2天 |
| 大修 | 每年 | 全面拆解检修 | 3-7天 |
**保养流程：**
```
保养计划 → 保养准备 → 保养执行 → 保养记录 → 验收确认
```
**保养内容：**
| 保养项目 | 保养内容 | 所需物料 |
|---------|---------|---------|
| 清洁 | 设备表面、内部清洁 | 清洁剂、抹布 |
| 润滑 | 运动部件润滑 | 润滑油 |
| 紧固 | 检查并紧固松动部件 | 扳手等工具 |
| 调整 | 调整设备参数 | 调试工具 |
| 更换 | 更换易损件 | 备件 |
### 2.4 设备故障管理
**故障分类：**
| 故障类别 | 说明 | 维修要求 |
|---------|------|---------|
| 轻微故障 | 不影响生产 | 2小时内修复 |
| 一般故障 | 部分功能受影响 | 4小时内修复 |
| 严重故障 | 设备停机 | 8小时内修复 |
| 紧急故障 | 设备损坏 | 立即响应 |
**故障处理流程：**
```
故障发现 → 故障报告 → 故障诊断 → 维修处理 → 维修验收 → 故障记录
```
**故障报修步骤：**
1. 发现设备故障
2. 评估故障影响
3. 紧急停机（如需要）
4. 提交故障报修单
5. 维修人员接单
6. 故障诊断
7. 执行维修
8. 维修验收
9. 故障记录归档
**故障报修信息：**
| 字段 | 说明 |
|------|------|
| 报修单号 | 报修单唯一标识 |
| 设备编号 | 故障设备 |
| 故障类型 | 故障类型 |
| 故障描述 | 故障情况描述 |
| 故障时间 | 发现故障时间 |
| 报修人 | 报告故障的人员 |
| 紧急程度 | 紧急/一般/轻微 |
| 影响范围 | 对生产的影响 |
**维修记录信息：**
| 记录项 | 说明 |
|--------|------|
| 维修单号 | 维修单唯一标识 |
| 维修人员 | 执行维修的人员 |
| 维修开始时间 | 开始维修时间 |
| 维修结束时间 | 完成维修时间 |
| 故障原因 | 导致故障的原因 |
| 维修措施 | 采取的维修方法 |
| 更换备件 | 更换的备件列表 |
| 维修结果 | 维修效果 |
### 2.5 设备OEE分析
**OEE概念：**
OEE（Overall Equipment Effectiveness）设备综合效率，是衡量设备实际生产能力与理论生产能力的比率。
**OEE计算公式：**
```
OEE = 可用率 × 性能率 × 合格率
其中：
- 可用率 = 实际运行时间 / 计划运行时间 × 100%
- 性能率 = 实际产出 / 理论产出 × 100%
- 合格率 = 合格品数量 / 总产出数量 × 100%
```
**OEE指标标准：**
| OEE值 | 等级 | 说明 |
|-------|------|------|
| ≥85% | 世界级 | 优秀 |
| 70%-85% | 良好 | 达标 |
| 60%-70% | 一般 | 需要改善 |
| <60% | 较差 | 需重点改善 |
**OEE分析维度：**
| 分析维度 | 损失类型 | 说明 |
|---------|---------|------|
| 可用率 | 故障停机 | 设备故障导致的停机 |
| 可用率 | 换型调试 | 产品换型、调试时间 |
| 性能率 | 空转小停顿 | 短暂停机 |
| 性能率 | 速度降低 | 运行速度低于理论速度 |
| 合格率 | 废品 | 不合格产品 |
| 合格率 | 返工 | 需要返工的产品 |
**OEE提升措施：**
| 损失类型 | 改善措施 |
|---------|---------|
| 故障停机 | 加强预防性维护 |
| 换型调试 | 优化换型流程 |
| 空转小停顿 | 优化作业流程 |
| 速度降低 | 设备升级改造 |
| 废品返工 | 加强质量控制 |
## 3. 仓储物流
### 3.1 仓库布局
**仓库区域规划：**
| 区域类型 | 用途 | 特点 |
|---------|------|------|
| 待检区 | 待检验物料 | 隔离存放 |
| 原材料区 | 原材料存储 | 按类别分区 |
| 半成品区 | 半成品存储 | 批次管理 |
| 成品区 | 成品存储 | 先进先出 |
| 退货区 | 退货物料 | 单独管理 |
| 废品区 | 废品存放 | 安全隔离 |
| 不良品区 | 不良品存放 | 标识清晰 |
**库位编码规则：**
| 编码示例 | 含义 |
|---------|------|
| A-01-001 | A区01排001位 |
| B-02-005 | B区02排005位 |
| C-03-010 | C区03排010位 |
### 3.2 入库管理
**入库类型：**
| 入库类型 | 说明 | 单据类型 |
|---------|------|---------|
| 采购入库 | 采购物料到货 | 采购入库单 |
| 生产入库 | 生产成品入库 | 生产入库单 |
| 退货入库 | 销售退货入库 | 退货入库单 |
| 调拨入库 | 其他仓库调拨入库 | 调拨单 |
| 其他入库 | 其他原因入库 | 其他入库单 |
**入库流程：**
```
┌──────────┐ ┌──────────┐ ┌──────────┐ ┌──────────┐
│ 到货 │───▶│ 单据 │───▶│ IQC │───▶│ 检验 │
│ 接收 │ │ 创建 │ │ 推送 │ │ 执行 │
└──────────┘ └──────────┘ └──────────┘ └──────────┘
│
▼
┌──────────┐ ┌──────────┐ ┌──────────┐ ┌──────────┐
│ 确认 │◀───│ 分配 │◀───│ 库位 │◀───│ 合格 │
│ 入库 │ │ 库位 │ │ 选择 │ │ 判定 │
└──────────┘ └──────────┘ └──────────┘ └──────────┘
```
**入库操作步骤：**
1. 物料到货，接收送货单
2. 创建入库单
3. 系统自动推送IQC检验任务
4. 执行来料检验
5. 检验合格后，分配库位
6. 物料上架到指定库位
7. 扫描库位确认
8. 完成入库
**入库单信息：**
| 字段 | 说明 |
|------|------|
| 入库单号 | 入库单唯一标识 |
| 入库类型 | 采购/生产/退货等 |
| 供应商 | 物料供应商（采购入库） |
| 关联单号 | 采购订单/工单等 |
| 入库日期 | 入库日期 |
| 物料明细 | 入库物料列表 |
| 仓库 | 入库仓库 |
| 状态 | 待检验/已入库等 |
### 3.3 出库管理
**出库类型：**
| 出库类型 | 说明 | 单据类型 |
|---------|------|---------|
| 生产领料 | 生产使用领料 | 领料单 |
| 销售出库 | 销售发货出库 | 销售出库单 |
| 退货出库 | 退货给供应商 | 退货单 |
| 调拨出库 | 调拨到其他仓库 | 调拨单 |
| 其他出库 | 其他原因出库 | 其他出库单 |
**出库流程：**
```
┌──────────┐ ┌──────────┐ ┌──────────┐ ┌──────────┐
│ 领料 │───▶│ 单据 │───▶│ 备料 │───▶│ 审核 │
│ 申请 │ │ 创建 │ │ 拣货 │ │ 通过 │
└──────────┘ └──────────┘ └──────────┘ └──────────┘
│
▼
┌──────────┐ ┌──────────┐
│ 确认 │◀───│ 扫描 │
│ 出库 │ │ 出库 │
└──────────┘ └──────────┘
```
**出库操作步骤：**
1. 根据工单或手工创建领料单
2. 选择需要的物料
3. 系统检查库存情况
4. 审核领料单
5. 仓库人员备料、拣货
6. 扫描物料和库位
7. 确认出库
8. 物料交付使用部门
**领料单信息：**
| 字段 | 说明 |
|------|------|
| 领料单号 | 领料单唯一标识 |
| 领料类型 | 生产领料/其他 |
| 关联工单 | 领料对应的工单 |
| 领料部门 | 领料的部门 |
| 领料人员 | 领料人员 |
| 领料日期 | 领料日期 |
| 物料明细 | 领料物料列表 |
| 仓库 | 出库仓库 |
| 状态 | 待审核/已领料等 |
### 3.4 库存管理
**库存查询：**
| 查询维度 | 查询内容 |
|---------|---------|
| 按物料查询 | 某物料的库存情况 |
| 按仓库查询 | 某仓库的库存情况 |
| 按库位查询 | 某库位的库存情况 |
| 按批次查询 | 某批次的库存情况 |
| 按库存状态 | 库存数量分布 |
**库存数据：**
| 数据项 | 说明 |
|--------|------|
| 物料编码 | 物料编号 |
| 物料名称 | 物料名称 |
| 仓库 | 所在仓库 |
| 库位 | 所在库位 |
| 批次 | 物料批次 |
| 数量 | 库存数量 |
| 单位 | 计量单位 |
| 库存状态 | 正常/冻结/待检 |
**库存账务：**
| 账务类型 | 说明 |
|---------|------|
| 期初库存 | 账期开始时的库存 |
| 本期入库 | 本期增加的数量 |
| 本期出库 | 本期减少的数量 |
| 期末库存 | 账期结束时的库存 |
**库存计算公式：**
```
期末库存 = 期初库存 + 本期入库 - 本期出库
```
### 3.5 批次管理
**批次追溯：**
| 追溯维度 | 追溯内容 |
|---------|---------|
| 正向追溯 | 原料→成品 |
| 逆向追溯 | 成品→原料 |
**批次信息：**
| 信息项 | 说明 |
|--------|------|
| 批次号 | 批次唯一标识 |
| 物料批次 | 物料批次 |
| 供应商批次 | 供应商提供的批次 |
| 生产批次 | 生产批次 |
| 入库日期 | 入库时间 |
| 保质期 | 保质期限 |
| 检验状态 | 合格/不合格 |
**先进先出（FIFO）：**
| 原则 | 说明 |
|------|------|
| 先入库先出库 | 较早入库的物料优先出库 |
| 保质期管理 | 近保质期的优先出库 |
| 批次清晰 | 批次标识清晰可追溯 |
### 3.6 库存预警
**预警类型：**
| 预警类型 | 触发条件 | 提醒内容 |
|---------|---------|---------|
| 安全库存预警 | 库存≤安全库存 | 库存不足提醒 |
| 保质期预警 | 临近保质期 | 保质期即将到期 |
| 呆滞预警 | 长期未使用 | 物料呆滞提醒 |
| 最大库存预警 | 库存≥最高库存 | 库存过高提醒 |
**库存控制策略：**
| 策略 | 说明 | 适用场景 |
|------|------|---------|
| 安全库存 | 最低库存保障 | 常规物料 |
| 最高库存 | 库存上限控制 | 避免积压 |
| 订货点法 | 库存到订货点时补货 | 定量采购 |
| 定期订货法 | 定期检查库存补货 | 定期采购 |
### 3.7 库存盘点
**盘点类型：**
| 盘点类型 | 说明 | 频率 |
|---------|------|------|
| 全面盘点 | 所有物料全面盘点 | 年末 |
| 部分盘点 | 部分物料盘点 | 每月/每周 |
| 循环盘点 | 按计划循环盘点 | 每日 |
| 动态盘点 | 实时盘点 | 持续 |
**盘点流程：**
```
盘点计划 → 盘点准备 → 初盘 → 复盘 → 差异审核 → 账务调整
```
**盘点步骤：**
1. 创建盘点单
2. 选择盘点仓库和物料
3. 执行初盘（首次清点）
4. 执行复盘（复核确认）
5. 核对系统账务
6. 分析盘点差异
7. 审核差异
8. 执行账务调整
**盘点记录：**
| 记录项 | 说明 |
|--------|------|
| 盘点单号 | 盘点单唯一标识 |
| 盘点类型 | 全面/部分/循环 |
| 盘点仓库 | 盘点仓库 |
| 盘点日期 | 盘点日期 |
| 账面数量 | 系统账面数量 |
| 实盘数量 | 实际盘点数量 |
| 差异数量 | 差异数量 |
| 差异原因 | 差异原因说明 |
| 审核状态 | 待审核/已审核 |
---
**设备与仓储篇完**

441
docs/business/production.md Normal file
View File

@@ -0,0 +1,441 @@
# 生产管理
## 1. 功能概述
生产管理模块是 MES 系统的核心模块，涵盖从生产计划到生产执行的全过程管理，实现生产过程的数字化、透明化和智能化。
**核心功能：**
| 功能 | 说明 |
|------|------|
| 生产计划 | 生产计划制定与分解 |
| 工单管理 | 工单的创建、审核、下发、变更 |
| 报工管理 | 生产报工、完工确认 |
| 生产监控 | 实时监控生产进度 |
| 物料流转 | 投料、领料、半成品流转 |
| 生产报表 | 生产数据统计分析 |
## 2. 生产计划管理
### 2.1 生产计划类型
| 计划类型 | 说明 | 时间范围 |
|---------|------|---------|
| 年度计划 | 年度生产大纲 | 1年 |
| 月度计划 | 月度生产计划 | 1个月 |
| 周计划 | 周生产排程 | 1周 |
| 日计划 | 日生产派工 | 1天 |
| 紧急计划 | 插单、变更计划 | 即时 |
### 2.2 生产计划来源
**计划生成方式：**
| 来源 | 说明 | 自动程度 |
|------|------|---------|
| 销售订单 | 根据销售订单生成 | 半自动 |
| 预测订单 | 根据预测数据生成 | 半自动 |
| 库存补货 | 根据库存低于安全线生成 | 自动 |
| 手工创建 | 手工制定计划 | 手动 |
### 2.3 计划平衡与分解
**计划平衡流程：**
```
┌─────────────┐ ┌─────────────┐ ┌─────────────┐ ┌─────────────┐
│ 需求计划 │───▶│ 能力检查 │───▶│ 计划调整 │───▶│ 计划确认 │
└─────────────┘ └─────────────┘ └─────────────┘ └─────────────┘
```
**能力评估要素：**
| 评估项目 | 评估内容 |
|---------|---------|
| 设备能力 | 设备产能是否满足 |
| 物料能力 | 物料是否齐套 |
| 人员能力 | 人员是否充足 |
| 工装能力 | 工装夹具是否到位 |
| 环境能力 | 生产环境是否满足 |
## 3. 工单管理
### 3.1 工单类型
| 工单类型 | 说明 | 触发方式 |
|---------|------|---------|
| 生产工单 | 正常生产工单 | 计划触发 |
| 返工工单 | 返工生产工单 | 质量问题触发 |
| 补料工单 | 物料追加工单 | 损耗触发 |
| 试做工单 | 试产工单 | 研发触发 |
| 紧急工单 | 紧急插单 | 临时触发 |
### 3.2 工单状态流转
**状态流转图：**
```
┌────────┐ ┌────────┐ ┌────────┐ ┌────────┐ ┌────────┐
│ 待制定 │───▶│ 已制定 │───▶│ 已审核 │───▶│ 已下发 │───▶│ 生产中 │
└────────┘ └────────┘ └────────┘ └────────┘ └────────┘
│ │
│ ▼
│ ┌────────┐
│ │ 已完工 │
└────────────────────────────────────────────────────▶│ │
└────────┘
```
**状态说明：**
| 状态 | 说明 | 可执行操作 |
|------|------|---------|
| 待制定 | 计划制定中 | 编辑、删除 |
| 已制定 | 计划已完成 | 提交审核、编辑 |
| 已审核 | 审核通过 | 下发 |
| 已下发 | 已下发到产线 | 开始生产 |
| 生产中 | 正在生产 | 报工、暂停 |
| 已完工 | 生产完成 | 入库、关闭 |
| 已关闭 | 工单关闭 | 查看 |
| 已取消 | 工单取消 | 查看 |
### 3.3 工单创建
**创建步骤：**
1. 进入【生产管理】→【工单管理】
2. 点击【新建工单】
3. 选择产品
4. 填写工单信息：
- 生产数量
- 计划开始/结束日期
- 计划产线
- 优先级
5. 系统自动计算物料需求
6. 保存工单
**【注意】** 创建工单前请确保产品BOM和工艺路线已维护完成。
### 3.4 工单信息
**工单基本信息：**
| 字段 | 说明 | 是否必填 |
|------|------|---------|
| 工单编号 | 工单唯一标识 | ✓ |
| 产品编码 | 生产产品 | ✓ |
| 产品名称 | 产品名称 | ✓ |
| 生产数量 | 计划生产数量 | ✓ |
| 合格数量 | 合格品数量 | - |
| 不良品数量 | 不良品数量 | - |
| 计划开工日 | 计划开工日期 | ✓ |
| 计划完工日 | 计划完工日期 | ✓ |
| 实际开工日 | 实际开工日期 | - |
| 实际完工日 | 实际完工日期 | - |
| 优先级 | 工单优先级 | ✓ |
| 工单状态 | 当前状态 | 系统自动 |
**工单关联信息：**
| 关联项 | 说明 |
|--------|------|
| 销售订单 | 关联的销售订单 |
| 客户信息 | 客户信息 |
| BOM版本 | 使用的BOM版本 |
| 工艺版本 | 使用的工艺版本 |
### 3.5 工单审核
**审核流程：**
1. 工单制定人提交审核
2. 审核人员收到审核任务
3. 审核工单信息
4. 检查物料齐套情况
5. 检查产能情况
6. 审核通过/驳回
**【提示】** 审核时可以调整工单数量和计划日期。
### 3.6 工单下发
**下发条件：**
| 条件 | 检查项 | 说明 |
|------|--------|------|
| 信息完整 | 所有必填项已填写 | ✓ |
| 审核通过 | 工单状态为已审核 | ✓ |
| BOM有效 | BOM已审核生效 | ✓ |
| 工艺有效 | 工艺路线已审核生效 | ✓ |
| 物料齐套 | 所需物料库存充足 | ✓ |
| 产线可用 | 产线处于可用状态 | ✓ |
**下发步骤：**
1. 选择已审核工单
2. 点击【下发】按钮
3. 系统执行齐套检查
4. 齐套检查通过
5. 确认下发信息
6. 工单状态变为"已下发"
**【注意】** 齐套检查不通过时，需要先补充物料或调整工单。
### 3.7 工单变更
**变更类型：**
| 变更类型 | 说明 | 变更影响 |
|---------|------|---------|
| 数量调整 | 增加/减少生产数量 | 影响物料需求 |
| 计划调整 | 调整计划日期 | 影响排程 |
| 产线变更 | 变更生产产线 | 影响排程 |
| 工序调整 | 调整工序顺序 | 影响工艺 |
| 紧急插单 | 调整工单优先级 | 影响排程 |
**变更流程：**
```
变更申请 → 变更审核 → 变更执行 → 变更确认
```
**【提示】** 工单在生产中变更需要谨慎，可能影响正在进行的生产作业。
## 4. 报工管理
### 4.1 报工类型
| 报工类型 | 说明 | 时机 |
|---------|------|------|
| 开工报工 | 工序开始作业 | 工序开工时 |
| 完工报工 | 工序完成作业 | 工序完工时 |
| 异常报工 | 工序异常暂停 | 发生异常时 |
| 交接班报工 | 交接班记录 | 交接班时 |
### 4.2 报工流程
**工序报工流程：**
```
开工报工 → 工序作业 → 完工报工 → 下一工序
```
**详细流程：**
```
┌──────────┐ ┌──────────┐ ┌──────────┐ ┌──────────┐
│ 开工 │───▶│ 作业 │───▶│ 完工 │───▶│ 质检 │
│ 报工 │ │ 进行中 │ │ 报工 │ │ 判定 │
└──────────┘ └──────────┘ └──────────┘ └──────────┘
│
┌──────────────────────────────────────┘
│
▼
┌──────────┐
│ 工序 │
│ 流转 │
└──────────┘
```
### 4.3 开工报工
**操作步骤：**
1. 进入【生产管理】→【报工管理】
2. 选择待开工的工单
3. 选择工序
4. 填写开工信息：
- 开工时间
- 作业人员
- 设备选择
5. 提交开工报工
6. 系统记录开工时间
**【提示】** 开工报工后，系统会锁定该工序，防止重复开工。
### 4.4 完工报工
**操作步骤：**
1. 选择已开工的工单
2. 选择工序
3. 填写完工信息：
- 完工数量
- 合格数量
- 不良品数量
- 不良原因（如有）
- 作业时间
- 物料消耗（如需）
4. 提交完工报工
5. 系统自动触发质量检验（如配置了检验点）
**完工报工信息：**
| 字段 | 说明 | 是否必填 |
|------|------|---------|
| 完工数量 | 本次完工数量 | ✓ |
| 合格数量 | 合格品数量 | ✓ |
| 不良品数量 | 不良品数量 | - |
| 不良原因 | 不良原因描述 | - |
| 作业工时 | 实际作业时间 | ✓ |
| 物料消耗 | 消耗的物料数量 | - |
### 4.5 报工数据
**报工记录信息：**
| 数据项 | 说明 |
|--------|------|
| 报工时间 | 报工操作时间 |
| 报工类型 | 开工/完工/异常 |
| 工单编号 | 关联工单 |
| 工序编号 | 关联工序 |
| 作业人员 | 执行作业的人员 |
| 设备编号 | 使用的设备 |
| 报工数量 | 报工数量 |
| 合格率 | 合格数量/报工数量 |
| 作业工时 | 实际作业时间 |
## 5. 生产监控
### 5.1 监控内容
**实时监控数据：**
| 监控项 | 说明 | 更新频率 |
|--------|------|---------|
| 工单进度 | 各工单完成情况 | 实时 |
| 工序进度 | 各工序完成情况 | 实时 |
| 产量统计 | 当日/当班产量 | 实时 |
| 不良品率 | 不良品比例 | 实时 |
| 设备状态 | 设备运行状态 | 实时 |
| 人员状态 | 作业人员状态 | 实时 |
### 5.2 监控看板
**生产看板展示：**
```
┌─────────────────────────────────────────────────────────────┐
│ 生产监控看板 │
├─────────────────────────────────────────────────────────────┤
│ │
│ 今日生产概况： │
│ ┌──────────────┐ ┌──────────────┐ ┌──────────────┐ │
│ │ 计划产量 │ │ 实际产量 │ │ 达成率 │ │
│ │ 10000 │ │ 9520 │ │ 95.2% │ │
│ └──────────────┘ └──────────────┘ └──────────────┘ │
│ │
│ 产线状态： │
│ ┌─────────────────────────────────────────────────────┐ │
│ │ SMT-A线 ████████████░░░░ 80% 运行中 │ │
│ │ SMT-B线 ██████████████░░ 85% 运行中 │ │
│ │ 组装-A线 ██████████░░░░░░ 60% 运行中 │ │
│ └─────────────────────────────────────────────────────┘ │
│ │
└─────────────────────────────────────────────────────────────┘
```
### 5.3 工序流转控制
**流转规则：**
| 流转类型 | 说明 | 配置要求 |
|---------|------|---------|
| 顺序流转 | 按工艺顺序依次作业 | 工艺路线定义 |
| 并行流转 | 多工序同时作业 | 工艺路线定义 |
| 条件流转 | 根据条件选择工序 | 流转条件配置 |
**工序开工条件：**
| 条件项 | 检查内容 |
|--------|---------|
| 前工序完成 | 前工序是否完工 |
| 物料齐套 | 物料是否到位 |
| 设备就绪 | 设备是否空闲 |
| 人员就绪 | 作业人员是否到位 |
## 6. 物料流转
### 6.1 投料管理
**投料流程：**
```
领料申请 → 仓库备料 → 扫描投料 → 系统确认
```
**投料方式：**
| 方式 | 说明 | 适用场景 |
|------|------|---------|
| 按工单投料 | 根据工单BOM投料 | 批量生产 |
| 按工序投料 | 根据工序需求投料 | 多工序生产 |
| 按产线投料 | 产线批量投料 | 连续生产 |
| 自动投料 | 系统自动控制投料 | 自动化产线 |
### 6.2 物料消耗记录
**消耗数据：**
| 数据项 | 说明 |
|--------|------|
| 物料编码 | 消耗的物料 |
| 物料批次 | 物料批次号 |
| 消耗数量 | 本次消耗数量 |
| 消耗时间 | 消耗时间 |
| 关联工单 | 关联的工单 |
| 关联工序 | 关联的工序 |
| 消耗方式 | 实际消耗/损耗 |
### 6.3 在制品（WIP）管理
**WIP监控：**
| 监控项 | 说明 |
|--------|------|
| 在制工单数 | 正在生产的工单数量 |
| 在制工序数 | 各工序进行中的数量 |
| 在制数量 | 各工序在制数量 |
| 流转时间 | 工件在各工序流转时间 |
| 堆积情况 | 各工序堆积情况 |
## 7. 生产统计与分析
### 7.1 生产报表
| 报表类型 | 说明 | 使用对象 |
|---------|------|---------|
| 生产日报 | 每日生产情况统计 | 车间主管 |
| 生产月报 | 每月生产情况统计 | 生产经理 |
| 工单统计 | 工单执行情况统计 | 计划员 |
| 产量统计 | 产量完成情况统计 | 生产主管 |
| 质量统计 | 生产质量情况统计 | 质量主管 |
### 7.2 生产指标
**核心KPI指标：**
| 指标 | 计算公式 | 说明 |
|------|---------|------|
| 产量达成率 | 实际产量/计划产量×100% | 目标：≥100% |
| 生产合格率 | 合格数量/总数量×100% | 目标：≥98% |
| 工时利用率 | 实际工时/可用工时×100% | 目标：≥85% |
| 工序流转时间 | 各工序平均流转时间 | 越短越好 |
| 在制品周转 | WIP数量/日产量 | 目标：3-5天 |
### 7.3 生产分析
**分析维度：**
| 分析维度 | 分析内容 |
|---------|---------|
| 产能分析 | 产能利用率、瓶颈分析 |
| 效率分析 | OEE分析、效率提升空间 |
| 质量分析 | 不良品分析、质量趋势 |
| 物料分析 | 物料消耗分析、超耗分析 |
| 工时分析 | 工时利用分析、加班分析 |
---
**生产管理篇完**

452
docs/business/quality.md Normal file
View File

@@ -0,0 +1,452 @@
# 质量与追溯
## 1. 功能概述
质量管理模块实现从原材料到成品的全流程质量控制，包括来料检验、过程检验、成品检验、质量异常处理和追溯管理，确保产品质量稳定可控。
**核心功能：**
| 功能 | 说明 |
|------|------|
| 检验标准 | 检验项目、检验标准定义 |
| IQC检验 | 来料质量控制 |
| IPQC检验 | 过程质量控制 |
| FQC/OQC | 成品/出货检验 |
| 质量异常 | 不良品处理、MRB管理 |
| 质量追溯 | 正向/逆向追溯 |
## 2. 质量管理体系
### 2.1 质量管理流程
**全面质量管理流程：**
```
原材料检验 → 生产过程控制 → 成品检验 → 出货检验
│ │ │ │
▼ ▼ ▼ ▼
IQC IPQC FQC OQC
```
### 2.2 质量管理原则
| 原则 | 说明 |
|------|------|
| 预防为主 | 将质量控制前移到设计和生产阶段 |
| 全员参与 | 质量是每一个人的责任 |
| 过程控制 | 关注生产过程的每一个环节 |
| 持续改进 | 不断优化质量管理体系 |
| 数据驱动 | 基于数据分析做出决策 |
## 3. 检验标准管理
### 3.1 检验标准定义
**检验标准组成：**
| 组成要素 | 说明 |
|---------|------|
| 检验类型 | IQC/IPQC/FQC/OQC |
| 检验项目 | 具体检验的项目 |
| 检验方法 | 如何进行检验 |
| 判断标准 | 合格/不合格的判定依据 |
| 检验设备 | 需要的检验设备 |
| 抽样方案 | 抽样数量和规则 |
### 3.2 检验项目类型
| 项目类型 | 说明 | 示例 |
|---------|------|------|
| 外观检验 | 视觉检查 | 颜色、形状、表面质量 |
| 尺寸检验 | 尺寸测量 | 长、宽、高、直径 |
| 功能检验 | 功能测试 | 电气性能、机械性能 |
| 性能检验 | 性能测试 | 寿命、可靠性 |
| 安全检验 | 安全测试 | 绝缘、耐压 |
### 3.3 检验标准创建
**创建步骤：**
1. 进入【质量管理】→【检验标准】
2. 点击【新建检验标准】
3. 填写标准信息：
- 标准编码
- 标准名称
- 适用产品
- 检验类型
4. 添加检验项目
5. 定义检验方法
6. 设置判断标准
7. 保存检验标准
**【提示】** 检验标准需要经过审核后才能生效使用。
### 3.4 抽样方案
**抽样标准：**
| 抽样标准 | 说明 | 适用场景 |
|---------|------|---------|
| GB/T 2828.1 | 正常检验一次抽样方案 | 常规检验 |
| GB/T 2829 | 周期检验抽样方案 | 定期抽检 |
| AQL抽样 | 允收质量水平抽样 | 大批量检验 |
| 全检 | 100%检验 | 关键项目 |
**AQL标准示例：**
| 检验批数量 | AQL 1.0 | AQL 2.5 | AQL 4.0 |
|-----------|---------|---------|---------|
| 26-50 | 3 | 5 | 7 |
| 51-90 | 5 | 7 | 10 |
| 91-150 | 8 | 12 | 18 |
| 151-280 | 13 | 18 | 25 |
## 4. 来料检验（IQC）
### 4.1 IQC流程
**IQC完整流程：**
```
┌──────────┐ ┌──────────┐ ┌──────────┐ ┌──────────┐
│ 到货 │───▶│ 入库单 │───▶│ IQC │───▶│ 判定 │
│ 接收 │ │ 创建 │ │ 检验 │ │ 判定 │
└──────────┘ └──────────┘ └──────────┘ └──────────┘
│
▼
┌──────────────────────────────────┐
│ 不合格处理 │
│ ┌──────┐ ┌──────┐ ┌──────┐ │
│ │ 退货 │ │ 让步 │ │ 报废 │ │
│ │ │ │ 接收 │ │ │ │
│ └──────┘ └──────┘ └──────┘ │
└──────────────────────────────────┘
```
### 4.2 IQC检验执行
**检验步骤：**
1. 供应商送货到达
2. 仓管员创建入库单
3. 系统自动推送检验任务到IQC
4. IQC检验员领取检验任务
5. 执行来料检验：
- 核对送货单与订单
- 外观检验
- 数量核对
- 抽样检验
6. 记录检验数据
7. 判定检验结果
**检验判定：**
| 判定结果 | 说明 | 处理方式 |
|---------|------|---------|
| 合格 | 允许入库 | 直接入库 |
| 让步接收 | 特殊放行 | 需审批 |
| 拒收 | 退货处理 | 退回供应商 |
### 4.3 IQC检验记录
**检验记录信息：**
| 记录项 | 说明 |
|--------|------|
| 检验单号 | IQC检验单编号 |
| 供应商 | 物料供应商 |
| 物料编码 | 检验的物料 |
| 物料批次 | 物料批次号 |
| 到货数量 | 到货数量 |
| 抽样数量 | 抽样检验数量 |
| 合格数量 | 合格数量 |
| 不良数量 | 不良数量 |
| 合格率 | 合格数量/抽样数量 |
| 检验结论 | 合格/不合格 |
| 检验员 | 执行检验的人员 |
| 检验时间 | 检验时间 |
## 5. 过程检验（IPQC）
### 5.1 IPQC类型
| 检验类型 | 时机 | 说明 |
|---------|------|------|
| 首件检验 | 每批次开始生产时 | 第一件产品的检验 |
| 巡检 | 生产过程中 | 定期巡查检验 |
| 抽检 | 按抽样方案 | 随机抽样检验 |
| 末件检验 | 每批次结束生产时 | 最后一件产品的检验 |
### 5.2 首件检验
**首件检验流程：**
```
开工生产 → 首件制作 → 首件检验 → 判定合格 → 批量生产
│
▼
判定不合格
│
▼
原因分析整改
```
**首件检验时机：**
| 时机 | 说明 |
|------|------|
| 换班首件 | 交接班后第一件 |
| 换料首件 | 更换物料后第一件 |
| 换工艺首件 | 调整工艺后第一件 |
| 设备维修后首件 | 设备维修后第一件 |
### 5.3 巡检管理
**巡检要点：**
| 巡检项目 | 检查内容 | 检查方法 |
|---------|---------|---------|
| 工艺参数 | 温度、压力、时间 | 查看设备参数 |
| 物料使用 | 物料是否正确 | 核对物料标识 |
| 作业方法 | 作业是否规范 | 观察作业过程 |
| 产品外观 | 外观是否正常 | 视觉检查 |
| 设备状态 | 设备是否正常 | 查看设备运行状态 |
**巡检记录：**
| 记录项 | 说明 |
|--------|------|
| 巡检时间 | 巡检时间 |
| 巡检工位 | 巡检的工位 |
| 巡检人员 | 执行巡检的人员 |
| 巡检项目 | 检查的项目 |
| 检查结果 | 检查结果 |
| 异常描述 | 发现的问题（如有） |
## 6. 成品检验（FQC/OQC）
### 6.1 FQC（最终检验）
**FQC检验内容：**
| 检验类别 | 检验项目 |
|---------|---------|
| 外观检验 | 颜色、标识、包装 |
| 尺寸检验 | 外形尺寸 |
| 功能检验 | 电气性能测试 |
| 安全检验 | 安全项目测试 |
| 可靠性检验 | 老化测试等 |
### 6.2 OQC（出货检验）
**OQC检验内容：**
| 检验项目 | 说明 |
|---------|------|
| 数量核对 | 核对出货数量 |
| 外观检查 | 检查包装外观 |
| 标识检查 | 检查标签、标识 |
| 随机抽检 | 按抽样方案抽检 |
| 文档检查 | 检查随货文件 |
### 6.3 成品入库流程
**入库条件：**
```
FQC检验合格 → OQC检验合格 → 包装完成 → 成品入库
```
**入库要求：**
| 要求项 | 说明 |
|--------|------|
| 检验完成 | FQC/OQC检验必须完成 |
| 检验合格 | 检验结果必须为合格 |
| 批次标识 | 必须有批次标识 |
| 包装完整 | 包装必须完整无损 |
| 数量准确 | 数量必须准确 |
## 7. 质量异常处理
### 7.1 不良品分类
| 不良类别 | 说明 | 处理方式 |
|---------|------|---------|
| 外观不良 | 颜色、形状、表面缺陷 | 返工/报废 |
| 尺寸不良 | 尺寸超出公差范围 | 返工/降级 |
| 功能不良 | 功能不达标 | 返工/报废 |
| 性能不良 | 性能不达标 | 返工/降级 |
| 安全不良 | 存在安全隐患 | 报废 |
### 7.2 MRB处理流程
**MRB流程：**
```
┌──────────┐ ┌──────────┐ ┌──────────┐ ┌──────────┐
│ 不良品 │───▶│ MRB │───▶│ 评审 │───▶│ 处置 │
│ 识别 │ │ 发起 │ │ 判定 │ │ 执行 │
└──────────┘ └──────────┘ └──────────┘ └──────────┘
```
**MRB处置方式：**
| 处置方式 | 说明 | 审批要求 |
|---------|------|---------|
| 返工 | 返回工序重新加工 | 需要审批 |
| 降级 | 降低产品等级使用 | 需要审批 |
| 让步接收 | 特殊情况下接收使用 | 高层审批 |
| 报废 | 直接报废处理 | 需要审批 |
| 退货 | 退回供应商 | 联系供应商 |
### 7.3 质量异常处理步骤
**处理步骤：**
1. 发现质量问题
2. 隔离不合格品
3. 标识不合格品
4. 创建MRB单
5. 质量评审
6. 评审结果判定
7. 执行处置方案
8. 处置确认
**【提示】** 不合格品必须隔离存放，防止误用。
## 8. 质量追溯
### 8.1 追溯内容
**追溯数据要素：**
| 追溯要素 | 追溯内容 |
|---------|---------|
| 物料来源 | 原材料供应商、批次 |
| 生产过程 | 工序、设备、人员 |
| 质量数据 | 检验记录、不良品 |
| 设备数据 | 设备参数、状态 |
| 环境数据 | 生产环境条件 |
### 8.2 正向追溯
**正向追溯流程：**
```
物料批次 → 半成品批次 → 成品批次 → 客户
```
**追溯查询：**
1. 输入成品批次号
2. 查询成品生产信息：
- 生产工单
- 生产工序
- 生产时间
- 作业人员
- 使用设备
3. 查询使用的物料：
- 物料批次
- 供应商
- IQC检验结果
4. 继续追溯物料的上游
### 8.3 逆向追溯
**逆向追溯流程：**
```
成品批次 → 半成品批次 → 物料批次 → 供应商
```
**追溯查询：**
1. 输入物料批次号
2. 查询物料使用情况：
- 使用的工单
- 使用的工序
- 生产的成品批次
3. 查询成品去向：
- 出货记录
- 客户信息
### 8.4 追溯查询示例
**查询场景：** 客户投诉某批次产品有质量问题
**追溯步骤：**
1. 根据客户提供的批次号查询
2. 追溯该批次的：
- 生产工单信息
- 各工序生产情况
- 使用物料批次
- 物料供应商
- 质量检验记录
3. 分析质量问题原因
4. 确定影响范围
5. 通知相关客户
6. 制定改进措施
**追溯结果示例：**
| 项目 | 信息 |
|------|------|
| 成品批次 | LOT-20260410-001 |
| 产品型号 | PCB-1000 |
| 生产工单 | WO-20260410001 |
| 生产日期 | 2026-04-10 |
| 生产产线 | SMT-A线 |
| 作业人员 | 张三、李四 |
| 使用物料 | 焊锡批次LOT-S-001（供应商：A公司） |
| 检验记录 | 首件合格、巡检合格 |
| 出货记录 | 出货给B客户，数量1000PCS |
## 9. 质量统计分析
### 9.1 质量指标
**核心质量KPI：**
| 指标 | 计算公式 | 目标值 |
|------|---------|--------|
| 来料合格率 | IQC合格批数/IQC总批数×100% | ≥98% |
| 过程合格率 | IPQC合格数/IPQC总检验数×100% | ≥99% |
| 成品合格率 | FQC合格数/FQC总检验数×100% | ≥99.5% |
| 不良品率 | 不良品数/总生产数×100% | ≤1% |
| 批次追溯率 | 追溯成功批次/总批次×100% | 100% |
### 9.2 质量报表
| 报表类型 | 说明 | 使用对象 |
|---------|------|---------|
| IQC日报 | 来料检验每日统计 | IQC组长 |
| IPQC日报 | 过程检验每日统计 | IPQC组长 |
| 质量月报 | 质量月度汇总报告 | 质量经理 |
| 不良品分析 | 不良品原因分析 | 质量工程师 |
| 趋势分析 | 质量趋势分析 | 质量主管 |
### 9.3 SPC统计过程控制
**控制图监控：**
| 控制图类型 | 监控内容 | 适用场景 |
|-----------|---------|---------|
| X-bar图 | 平均值监控 | 计量数据 |
| R图 | 极差监控 | 计量数据 |
| P图 | 不良率监控 | 计数数据 |
| C图 | 缺陷数监控 | 计数数据 |
**异常判定规则：**
| 规则 | 判定条件 | 说明 |
|------|---------|------|
| 规则1 | 1点超出控制限 | 单点异常 |
| 规则2 | 连续9点在中心线同一侧 | 偏移异常 |
| 规则3 | 连续6点递增或递减 | 趋势异常 |
| 规则4 | 连续14点交替上下 | 周期性异常 |
---
**质量与追溯篇完**

372
docs/getting-started/quick-start.md Normal file
View File

@@ -0,0 +1,372 @@
# 快速入门
## 1. 系统登录
### 1.1 登录前准备
在登录系统前，请确保您已完成以下准备工作：
| 准备项 | 说明 |
|--------|------|
| 账户开通 | 联系系统管理员申请账户 |
| 浏览器准备 | 建议使用 Chrome、Firefox 或 Edge 浏览器 |
| 网络连接 | 确保能够访问 MES 系统服务器 |
| 客户端安装 | 部分功能需要安装插件（首次登录时提示） |
### 1.2 登录操作
**登录步骤：**
1. 打开浏览器，输入系统地址（如：`http://mes.yourcompany.com`）
2. 进入登录页面
3. 输入用户名和密码
4. 点击【登录】按钮
5. 系统验证通过后进入主界面
**【提示】** 首次登录建议修改初始密码，并完善个人资料。
### 1.3 忘记密码
如果您忘记了密码，可以通过以下方式重置：
| 重置方式 | 操作方法 |
|---------|---------|
| 自助找回 | 点击登录页"忘记密码"，通过绑定的邮箱/手机重置 |
| 管理员重置 | 联系系统管理员手动重置密码 |
## 2. 系统主界面
### 2.1 主界面布局
```
┌────────────────────────────────────────────────────────────┐
│ 顶部栏 │
│ ┌──────────────┬──────────────────────────────┬─────────┐ │
│ │ Logo │ 系统名称 │ 用户信息 │ │
│ └──────────────┴──────────────────────────────┴─────────┘ │
├────────────────────────────────────────────────────────────┤
│ 导航栏 │
│ ┌────────────────────────────────────────────────────────┐ │
│ │ 📊 首页 │ 📋 生产 │ 📦 质量 │ 🏭 仓库 │ 🔧 设备 │ ⚙️ 系统 │ │
│ └────────────────────────────────────────────────────────┘ │
├────────────────────────────────────────────────────────────┤
│ │
│ 主内容区 │
│ ┌────────────────────────────────────────────────────────┐ │
│ │ │ │
│ │ 欢迎使用 HF-MES v5.0 制造执行系统 │ │
│ │ │ │
│ │ ┌─────────────┐ ┌─────────────┐ │ │
│ │ │ 待办事项 │ │ 生产看板 │ │ │
│ │ └─────────────┘ └─────────────┘ │ │
│ │ │ │
│ └────────────────────────────────────────────────────────┘ │
│ │
└────────────────────────────────────────────────────────────┘
```
### 2.2 功能菜单
系统主要功能模块包括：
| 模块 | 功能说明 |
|------|---------|
| 首页 | 系统首页、待办事项、生产看板 |
| 生产管理 | 工单管理、报工管理、生产监控 |
| 质量管理 | 来料检验、过程检验、质量追溯 |
| 仓储物流 | 入库管理、出库管理、库存管理 |
| 设备管理 | 设备台账、点检保养、故障维修 |
| 系统管理 | 用户管理、角色权限、参数配置 |
### 2.3 快捷操作
| 快捷键 | 功能 |
|--------|------|
| `Ctrl + S` | 保存 |
| `Ctrl + N` | 新建 |
| `Ctrl + F` | 搜索/筛选 |
| `F5` | 刷新 |
| `Esc` | 取消 |
## 3. 基础操作流程
### 3.1 工单完整流程
下面以一个典型的生产工单为例，介绍完整的操作流程：
**流程概览：**
```
创建工单 → 审核工单 → 下发工单 → 领料投料 → 开工报工 → 工序流转 → 完工入库
```
#### 3.1.1 创建工单
**操作步骤：**
1. 进入【生产管理】→【工单管理】
2. 点击【新建】按钮
3. 填写工单信息：
- 选择产品
- 填写生产数量
- 设置计划开始/结束日期
- 选择产线/车间
4. 点击【保存】
**【提示】** 带 * 号的字段为必填项。
#### 3.1.2 审核工单
**操作步骤：**
1. 在工单列表中找到待审核工单
2. 点击工单编号查看详情
3. 审核工单信息
4. 点击【审核通过】或【驳回】
**【注意】** 审核驳回后需要修改后重新提交。
#### 3.1.3 下发工单
**操作步骤：**
1. 在工单列表中找到已审核工单
2. 点击【下发】按钮
3. 系统自动检查物料齐套情况
4. 齐套检查通过后确认下发
5. 工单状态变更为"已下发"
**【注意】** 下发前请确保物料、设备、人员已准备就绪。
#### 3.1.4 领料投料
**操作步骤：**
1. 进入【仓储物流】→【领料管理】
2. 点击【新建领料单】
3. 选择对应工单
4. 系统自动带出物料清单
5. 确认领料数量
6. 提交审核
7. 审核通过后到仓库领料
8. 扫描物料条码投料
#### 3.1.5 报工管理
**工序报工流程：**
```
开工报工 → 工序作业 → 完工报工
```
**开工报工：**
1. 进入【生产管理】→【报工管理】
2. 选择对应工单
3. 执行开工报工
4. 记录开工时间
**完工报工：**
1. 完成工序作业后
2. 执行完工报工
3. 填写完工数量、不良品数量
4. 提交报工数据
#### 3.1.6 完工入库
**操作步骤：**
1. 工单所有工序完成后
2. 进入工单详情
3. 点击【完工确认】
4. 确认入库信息
5. 生成入库单
6. 物料入库到仓库
### 3.2 质量管理流程
#### 3.2.1 来料检验（IQC）
**操作步骤：**
1. 供应商送货到达
2. 仓管员创建入库单
3. 系统自动推送检验任务
4. 质检员领取检验任务
5. 执行来料检验
6. 判定合格/不合格
7. 不合格走MRB流程
#### 3.2.2 过程检验（IPQC）
**检验时机：**
| 检验类型 | 执行时机 |
|---------|---------|
| 首件检验 | 每批次产品开始生产时 |
| 巡检 | 生产过程中定期执行 |
| 抽检 | 按抽样方案定期执行 |
| 末件检验 | 每批次产品生产结束时 |
### 3.3 仓储管理流程
#### 3.3.1 入库流程
```
到货 → 创建入库单 → IQC检验 → 分配库位 → 上架确认
```
#### 3.3.2 出库流程
```
领料申请 → 审核 → 备料 → 扫描出库 → 投料生产
```
## 4. 常用操作示例
### 4.1 如何查询工单
**方法一：通过列表筛选**
1. 进入【生产管理】→【工单管理】
2. 在筛选条件中输入查询条件：
- 工单编号
- 产品名称
- 工单状态
- 日期范围
3. 点击【查询】按钮
4. 查看查询结果
**方法二：通过搜索框**
1. 在页面顶部的搜索框中
2. 输入工单编号或产品名称
3. 按回车键搜索
4. 系统自动跳转到工单详情
### 4.2 如何进行报工
**操作步骤：**
1. 进入【生产管理】→【报工管理】
2. 当前用户待报工的工单列表
3. 选择需要报工的工单
4. 选择工序
5. 填写报工信息：
- 报工类型（开工/完工）
- 报工数量
- 不良品数量（如有）
- 作业时间
6. 提交报工数据
**【提示】** 完工报工后，系统会自动触发下一工序的开工作业。
### 4.3 如何查看生产进度
**操作步骤：**
1. 进入【生产管理】→【生产监控】
2. 选择产线或工单
3. 查看实时生产状态：
- 工序进度
- 产量统计
- 不良品率
- 达成率
4. 点击详情查看更多信息
### 4.4 如何进行批次追溯
**操作步骤：**
1. 进入【质量管理】→【质量追溯】
2. 输入追溯信息：
- 批次号
- 产品编号
- 日期范围
3. 执行追溯查询
4. 查看追溯结果：
- 物料来源
- 生产过程
- 质量数据
- 出货去向
## 5. 常见问题速查
### 5.1 登录问题
**Q1: 提示"用户名或密码错误"**
| 可能原因 | 解决方案 |
|---------|---------|
| 输入错误 | 检查用户名和密码 |
| 大小写问题 | 确认Caps Lock未开启 |
| 账户锁定 | 等待30分钟或联系管理员 |
**Q2: 提示"无访问权限"**
| 可能原因 | 解决方案 |
|---------|---------|
| 未分配角色 | 联系管理员分配权限 |
| 权限不足 | 申请更高权限 |
### 5.2 操作问题
**Q3: 页面显示异常**
| 解决方案 | 操作方式 |
|---------|---------|
| 清除缓存 | Ctrl + Shift + Delete |
| 更换浏览器 | 使用推荐的浏览器 |
| 检查分辨率 | 确保分辨率≥1280×720 |
**Q4: 数据保存失败**
| 可能原因 | 解决方案 |
|---------|---------|
| 必填字段未填 | 检查必填项 |
| 数据格式错误 | 修正数据格式 |
| 网络问题 | 检查网络连接 |
| 会话过期 | 重新登录 |
### 5.3 业务问题
**Q5: 工单无法下发**
| 可能原因 | 解决方案 |
|---------|---------|
| 物料未齐套 | 检查物料库存 |
| 产线不可用 | 检查产线状态 |
| 工艺路线未维护 | 维护工艺路线 |
**Q6: 报工数据无法提交**
| 可能原因 | 解决方案 |
|---------|---------|
| 工序未开工 | 先执行开工报工 |
| 数据格式错误 | 检查输入数据 |
| 数量超出范围 | 确认数量在允许范围内 |
## 6. 下一步学习
恭喜您完成快速入门学习！接下来您可以：
| 学习路径 | 建议内容 |
|---------|---------|
| 深入学习 | 阅读详细的功能模块文档 |
| 日常操作 | 根据实际业务场景练习 |
| 问题解决 | 查看异常处理与技术支持章节 |
**推荐学习顺序：**
1. 📖 [系统概述](/guide/system-overview) - 了解系统整体架构
2. 📋 [基础数据管理](/basic/data-management) - 掌握基础数据配置
3. 🏭 [生产管理](/business/production) - 熟悉生产业务操作
4. 📊 [质量管理](/business/quality) - 了解质量控制流程
5. ⚙️ [系统运维](/operation/system-operation) - 学习系统管理
**【提示】** 如遇到问题，请查阅 [异常处理与技术支持](/operation/technical-support) 章节。
---
**快速入门篇完**

154
docs/guide/document-guide.md Normal file
View File

@@ -0,0 +1,154 @@
# 文档说明
## 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 代码块
使用 ``` 包裹代码块，例如：
```bash
# 示例命令
cd /opt/mes
./start.sh
```
## 6. 文档维护
### 6.1 更新频率
- 常规更新：每月一次
- 紧急更新：随时发布
### 6.2 反馈渠道
如果您发现文档内容有误或需要补充，请通过以下方式反馈：
- 邮箱：docs-feedback@hfmes.com
- 服务热线：400-XXX-XXXX
## 7. Mermaid 流程图测试
### 7.1 基础流程图示例
以下是一个简单的工单处理流程图示例：
```mermaid
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 序列图示例
```mermaid
sequenceDiagram
participant 用户
participant 系统
participant 设备
用户->>系统: 提交工单
系统->>设备: 下发生产指令
设备->>系统: 报工数据
系统->>用户: 返回处理结果
```
## 8. 版权声明
本文档版权归 HF-MES 所属公司所有，未经许可不得擅自复制、传播或修改。
---
**文档说明篇完**

376
docs/guide/system-overview.md Normal file
View File

@@ -0,0 +1,376 @@
# 文档说明
## 系统概述
## 1. 系统简介
HF-MES v5.0（Manufacturing Execution System）是一套面向制造企业的生产执行管理系统，旨在实现生产过程的数字化、智能化管理，提高生产效率、保证产品质量、降低运营成本。
### 1.1 系统定位
```
┌─────────────────────────────────────────────────────────┐
│ 企业信息化金字塔 │
├─────────────────────────────────────────────────────────┤
│ │
│ ┌─────────────┐ │
│ │ ERP │ 企业资源计划 │
│ │ 企业管理层 │ │
│ └──────┬──────┘ │
│ │ │
│ ┌──────▼──────┐ │
│ │ MES │ 制造执行系统 │
│ │ 生产执行层 │ ← 我们的系统 │
│ └──────┬──────┘ │
│ │ │
│ ┌──────▼──────┐ │
│ │ SCADA │ 数据采集与监控系统 │
│ │ 设备控制层 │ │
│ └─────────────┘ │
│ │
└─────────────────────────────────────────────────────────┘
```
### 1.2 核心价值
| 核心价值 | 说明 | 客户收益 |
|---------|------|---------|
| 生产透明化 | 实时监控生产进度 | 掌握实时生产状态 |
| 过程可追溯 | 全流程数据追溯 | 质量问题快速定位 |
| 质量可控 | 全过程质量控制 | 产品质量有保障 |
| 效率提升 | 优化生产流程 | 生产效率提升 |
| 成本降低 | 减少浪费损耗 | 生产成本下降 |
## 2. 系统架构
### 2.1 技术架构
**系统采用前后端分离架构：**
| 层级 | 技术栈 | 说明 |
|------|--------|------|
| 前端展示层 | Vue.js + Element UI | 用户界面交互 |
| 后端服务层 | Java Spring Boot | 业务逻辑处理 |
| 数据存储层 | MySQL + Redis | 数据存储与缓存 |
| 消息中间件 | RabbitMQ | 异步消息处理 |
| 文件存储 | MinIO/OSS | 文件与附件存储 |
### 2.2 系统部署架构
```
┌────────────────────────────────────────────────────────────┐
│ 客户端层 │
│ ┌──────────────┐ ┌──────────────┐ ┌──────────────┐ │
│ │ Web浏览器 │ │ 移动端 │ │ 大屏展示 │ │
│ └──────────────┘ └──────────────┘ └──────────────┘ │
└────────────────────────────────────────────────────────────┘
│
▼
┌────────────────────────────────────────────────────────────┐
│ 应用服务层 │
│ ┌──────────────┐ ┌──────────────┐ ┌──────────────┐ │
│ │ Web服务 │ │ API服务 │ │ 定时服务 │ │
│ │ (Nginx) │ │ (Gateway) │ │ (Scheduler) │ │
│ └──────────────┘ └──────────────┘ └──────────────┘ │
└────────────────────────────────────────────────────────────┘
│
▼
┌────────────────────────────────────────────────────────────┐
│ 数据服务层 │
│ ┌──────────────┐ ┌──────────────┐ ┌──────────────┐ │
│ │ 数据库 │ │ 缓存 │ │ 消息队列 │ │
│ │ (MySQL) │ │ (Redis) │ │ (RabbitMQ) │ │
│ └──────────────┘ └──────────────┘ └──────────────┘ │
└────────────────────────────────────────────────────────────┘
│
▼
┌────────────────────────────────────────────────────────────┐
│ 设备集成层 │
│ ┌──────────────┐ ┌──────────────┐ ┌──────────────┐ │
│ │ PLC/SCADA │ │ RFID │ │ 条码枪 │ │
│ └──────────────┘ └──────────────┘ └──────────────┘ │
└────────────────────────────────────────────────────────────┘
```
### 2.3 系统网络架构
```
┌─────────────────┐
│ 互联网用户 │
└────────┬────────┘
│
▼
┌────────────────────────────────────────────────────────────┐
│ 企业内网 │
│ │
│ ┌────────────────────┐ ┌────────────────────┐ │
│ │ MES应用服务器 │◀────▶│ ERP服务器 │ │
│ │ (应用集群) │ │ (SAP/用友/金蝶) │ │
│ └─────────┬──────────┘ └────────────────────┘ │
│ │ │
│ ├──────────┬──────────┬──────────┐ │
│ │ │ │ │ │
│ ▼ ▼ ▼ ▼ │
│ ┌────────┐ ┌────────┐ ┌────────┐ ┌────────┐ │
│ │ 车间1 │ │ 车间2 │ │ 车间3 │ │ 仓库 │ │
│ │ 客户端 │ │ 客户端 │ │ 客户端 │ │ 客户端 │ │
│ └────────┘ └────────┘ └────────┘ └────────┘ │
│ │ │ │ │ │
│ └──────────┴──────────┴──────────┘ │
│ │ │
│ ▼ │
│ ┌────────────┐ │
│ │ 数据库服务器 │ │
│ │ (主备集群) │ │
│ └────────────┘ │
└────────────────────────────────────────────────────────────┘
```
## 3. 功能模块
### 3.1 功能模块总览
```
┌─────────────────────────────────────────────────────────┐
│ HF-MES v5.0 功能架构 │
├─────────────────────────────────────────────────────────┤
│ │
│ ┌─────────────────────────────────────────────────┐ │
│ │ 系统管理层 │ │
│ │ ┌────────┐ ┌────────┐ ┌────────┐ ┌────────┐ │ │
│ │ │ 用户管理 │ │ 角色管理 │ │ 权限管理 │ │ 参数配置 │ │ │
│ │ └────────┘ └────────┘ └────────┘ └────────┘ │ │
│ └─────────────────────────────────────────────────┘ │
│ │
│ ┌─────────────────────────────────────────────────┐ │
│ │ 生产管理层 │ │
│ │ ┌────────┐ ┌────────┐ ┌────────┐ ┌────────┐ │ │
│ │ │ 生产计划 │ │ 工单管理 │ │ 报工管理 │ │ 生产调度 │ │ │
│ │ └────────┘ └────────┘ └────────┘ └────────┘ │ │
│ └─────────────────────────────────────────────────┘ │
│ │
│ ┌─────────────────────────────────────────────────┐ │
│ │ 质量管理层 │ │
│ │ ┌────────┐ ┌────────┐ ┌────────┐ ┌────────┐ │ │
│ │ │ 来料检验 │ │ 过程检验 │ │ 成品检验 │ │ 质量追溯 │ │ │
│ │ └────────┘ └────────┘ └────────┘ └────────┘ │ │
│ └─────────────────────────────────────────────────┘ │
│ │
│ ┌─────────────────────────────────────────────────┐ │
│ │ 仓储管理层 │ │
│ │ ┌────────┐ ┌────────┐ ┌────────┐ ┌────────┐ │ │
│ │ │ 入库管理 │ │ 出库管理 │ │ 库存管理 │ │ 库位管理 │ │ │
│ │ └────────┘ └────────┘ └────────┘ └────────┘ │ │
│ └─────────────────────────────────────────────────┘ │
│ │
│ ┌─────────────────────────────────────────────────┐ │
│ │ 设备管理层 │ │
│ │ ┌────────┐ ┌────────┐ ┌────────┐ ┌────────┐ │ │
│ │ │ 设备台账 │ │ 点检保养 │ │ 故障维修 │ │ OEE分析 │ │ │
│ │ └────────┘ └────────┘ └────────┘ └────────┘ │ │
│ └─────────────────────────────────────────────────┘ │
│ │
│ ┌─────────────────────────────────────────────────┐ │
│ │ 报表管理层 │ │
│ │ ┌────────┐ ┌────────┐ ┌────────┐ ┌────────┐ │ │
│ │ │ 生产报表 │ │ 质量报表 │ │ 设备报表 │ │ 库存报表 │ │ │
│ │ └────────┘ └────────┘ └────────┘ └────────┘ │ │
│ └─────────────────────────────────────────────────┘ │
│ │
└─────────────────────────────────────────────────────────┘
```
### 3.2 模块详细介绍
#### 3.2.1 生产管理模块
**核心功能：**
| 功能 | 说明 |
|------|------|
| 生产计划 | 根据销售订单生成生产计划 |
| 工单管理 | 工单的创建、审核、下发、变更 |
| 报工管理 | 生产报工、完工确认 |
| 生产监控 | 实时监控生产进度、状态 |
| 工序管理 | 工艺路线、工序定义 |
| 物料流转 | 投料、领料、半成品流转 |
#### 3.2.2 质量管理模块
**核心功能：**
| 功能 | 说明 |
|------|------|
| 检验标准 | 检验项目、检验标准定义 |
| IQC检验 | 来料质量控制 |
| IPQC检验 | 过程质量控制 |
| FQC/OQC | 成品/出货检验 |
| 质量异常 | 不良品处理、MRB管理 |
| 质量追溯 | 正向/逆向追溯 |
#### 3.2.3 仓储管理模块
**核心功能：**
| 功能 | 说明 |
|------|------|
| 入库管理 | 采购入库、生产入库、其他入库 |
| 出库管理 | 生产领料、销售出库、其他出库 |
| 库存管理 | 库存查询、库存预警、库存盘点 |
| 库位管理 | 库位定义、库位分配 |
| 批次管理 | 批次定义、批次追溯 |
| 齐套检查 | 物料齐套性检查 |
#### 3.2.4 设备管理模块
**核心功能：**
| 功能 | 说明 |
|------|------|
| 设备台账 | 设备信息、分类管理 |
| 点检管理 | 日常点检、点检标准 |
| 保养管理 | 计划保养、保养标准 |
| 故障管理 | 故障报修、维修记录 |
| OEE分析 | 设备综合效率分析 |
| 备件管理 | 备件库存、备件领用 |
### 3.3 功能矩阵
| 功能模块 | 基础版 | 标准版 | 高级版 | 旗舰版 |
|---------|--------|--------|--------|--------|
| 生产管理 | ✓ | ✓ | ✓ | ✓ |
| 质量管理 | ✓ | ✓ | ✓ | ✓ |
| 仓储管理 | ✓ | ✓ | ✓ | ✓ |
| 设备管理 | - | ✓ | ✓ | ✓ |
| 报表分析 | 基础 | 基础 | 高级 | 高级 |
| 系统集成 | - | 基础 | 高级 | 高级 |
| 二次开发 | - | - | ✓ | ✓ |
| 私有化部署 | - | - | ✓ | ✓ |
## 4. 适用行业
### 4.1 典型行业应用
| 行业 | 典型场景 |
|------|---------|
| 电子制造 | SMT贴片、组装测试、包装出货 |
| 汽车零部件 | 冲压、焊接、涂装、总装 |
| 机械加工 | CNC加工、装配、检测 |
| 食品饮料 | 配方生产、灌装包装、质量追溯 |
| 医药化工 | 制剂生产、包装、批次追溯 |
| 新能源 | 电池生产、光伏组件 |
### 4.2 行业解决方案
针对不同行业，我们提供定制化的解决方案，包括：
- 行业专用功能模块
- 行业最佳实践流程
- 行业特色报表模板
- 行业集成接口方案
## 5. 性能指标
### 5.1 系统性能
| 指标 | 标准值 | 说明 |
|------|--------|------|
| 系统响应时间 | < 3秒 | 页面加载时间 |
| 接口响应时间 | < 1秒 | API调用响应 |
| 并发用户数 | 500+ | 同时在线用户 |
| 数据处理能力 | 10万+/日 | 日处理单据量 |
| 系统可用性 | 99.9% | 系统正常运行时间 |
| 数据备份 | 每日增量 | 自动备份机制 |
### 5.2 运行环境
| 环境要求 | 配置 |
|---------|------|
| 浏览器 | Chrome、Firefox、Edge、360等 |
| 最低分辨率 | 1280×720 |
| 网络要求 | 局域网≥100M |
| 服务器配置 | CPU 8核+，内存 16G+，硬盘 500G+ |
## 6. 安全特性
### 6.1 安全保障体系
| 安全维度 | 保障措施 |
|---------|---------|
| 身份认证 | 用户名密码、LDAP集成 |
| 权限控制 | RBAC权限模型 |
| 数据安全 | 传输加密、敏感字段加密 |
| 操作审计 | 完整操作日志记录 |
| 安全策略 | 密码策略、会话管理 |
| 数据备份 | 自动备份、异地备份 |
### 6.2 权限模型
```
┌─────────────────────────────────────────────────────────┐
│ 权限模型 │
├─────────────────────────────────────────────────────────┤
│ │
│ ┌─────────┐ │
│ │ 用户 │ ←────────────┐ │
│ └────┬────┘ │ │
│ │ │ 归属 │
│ ▼ │ │
│ ┌─────────┐ │ │
│ │ 角色 │──────────────┼──────────┐ │
│ └────┬────┘ │ │ │
│ │ │ 拥有 │ │
│ ▼ │ ▼ │
│ ┌─────────┐ │ ┌───────────┐ │
│ │ 权限点 │◀─────────────┘ │ 功能菜单 │ │
│ └─────────┘ └───────────┘ │
│ │
│ ┌─────────────────────────────────────────────────┐ │
│ │ 数据权限 │ │
│ │ 工厂级 ─ 车间级 ─ 产线级 ─ 个人数据 │ │
│ └─────────────────────────────────────────────────┘ │
│ │
└─────────────────────────────────────────────────────────┘
```
## 7. 与其他系统集成
### 7.1 系统集成架构
```
┌─────────────────────────────────────────────────────────┐
│ 系统集成架构 │
├─────────────────────────────────────────────────────────┤
│ │
│ ┌───────────┐ │
│ │ ERP │ ←──→ 物料主数据、工单、采购订单 │
│ │ (SAP) │ │
│ └─────┬─────┘ │
│ │ │
│ ▼ │
│ ┌───────────┐ │
│ │ MES │ ←──→ 生产执行、质量数据、设备数据 │
│ │ (自身) │ │
│ └─────┬─────┘ │
│ │ │
│ ▼ │
│ ┌───────────┐ │
│ │ SCADA │ ←──→ 设备数据、实时状态 │
│ │ (设备层) │ │
│ └───────────┘ │
│ │
└─────────────────────────────────────────────────────────┘
```
### 7.2 集成方式
| 集成方式 | 说明 | 适用场景 |
|---------|------|---------|
| API接口 | RESTful API | 实时数据交换 |
| 中间库 | 数据库直连 | 批量数据同步 |
| 文件导入 | Excel/CSV导入 | 周期性数据交换 |
| 消息队列 | 事件驱动 | 异步消息通知 |
| WebService | SOAP接口 | 传统系统集成 |
---
**系统概述篇完**

38
docs/index.md Normal file
View File

@@ -0,0 +1,38 @@
---
layout: home
hero:
name: "HF-MES v5.0"
text: "制造执行系统使用手册"
tagline: "数字化生产 · 智能化执行 · 透明化管理"
actions:
- theme: brand
text: 快速入门
link: /getting-started/quick-start
- theme: alt
text: 系统概述
link: /guide/system-overview
features:
- icon: 🏭
title: 生产管理
details: 全面覆盖生产计划、工单执行、报工管理、过程监控等核心业务
- icon: 📊
title: 质量管理
details: 实现从原材料到成品的全流程质量控制与追溯管理
- icon: 📦
title: 仓储物流
details: 优化库存管理、入出库流程、物料流转与追溯
- icon: 🔧
title: 设备管理
details: 设备全生命周期管理、点检保养、OEE分析
- icon: 🔗
title: 系统集成
details: 与ERP、SCADA等系统无缝集成，数据互联互通
- icon: 📈
title: 报表分析
details: 丰富的统计分析报表，辅助决策支持
footer: |
HF-MES v5.0 使用手册 · Copyright © 2026 All Rights Reserved
---

289
docs/integration/data-integration.md Normal file
View File

@@ -0,0 +1,289 @@
# 数据与集成
## 1. 功能概述
数据与集成模块实现 MES 系统与 ERP、SCADA、PLC 等系统的数据互联互通，打通企业信息孤岛，实现数据共享和业务协同。
**核心功能：**
| 功能 | 说明 |
|------|------|
| 接口管理 | 接口配置与监控 |
| 数据同步 | 主数据同步 |
| 消息集成 | 消息队列集成 |
| 文件传输 | 文件数据交换 |
## 2. 系统集成架构
### 2.1 集成架构图
```
┌─────────────────────────────────────────────────────────────┐
│ 企业应用集成架构 │
├─────────────────────────────────────────────────────────────┤
│ │
│ ┌─────────┐ │
│ │ ERP │ ─────────────────────────────────────────▶ │
│ │ SAP/用友 │ 物料主数据、采购订单、生产计划、销售订单 │
│ └────┬────┘ │
│ │ │
│ │ ◀───────────────────────────────────────── │
│ │ 工单完工、质量数据、库存数据 │
│ ▼ │
│ ┌─────────┐ │
│ │ MES │ │
│ │ MES │ ──────────────────────────────────────────▶ │
│ └────┬────┘ 工单执行、产量数据、质量数据 │
│ │ │
│ │ ◀───────────────────────────────────────── │
│ │ 设备运行参数、状态数据 │
│ ▼ │
│ ┌─────────┐ │
│ │ SCADA │ ──────────────────────────────────────────▶ │
│ │ PLC/RTU │ 设备数据采集、实时监控 │
│ └─────────┘ │
│ │
│ ┌─────────────────────────────────────────────────────┐ │
│ │ 集成中间件 │ │
│ │ ┌────────┐ ┌────────┐ ┌────────┐ ┌────────┐ │ │
│ │ │消息队列 │ │数据总线 │ │文件传输 │ │API网关 │ │ │
│ │ └────────┘ └────────┘ └────────┘ └────────┘ │ │
│ └─────────────────────────────────────────────────────┘ │
│ │
└─────────────────────────────────────────────────────────────┘
```
### 2.2 集成方式对比
| 集成方式 | 实时性 | 复杂度 | 数据量 | 适用场景 |
|---------|--------|--------|--------|---------|
| API接口 | 高 | 中 | 中 | 实时交互 |
| 中间库 | 低 | 低 | 大 | 批量同步 |
| 消息队列 | 中 | 中 | 中 | 异步消息 |
| 文件交换 | 低 | 低 | 大 | 批量数据 |
## 3. 接口管理
### 3.1 接口类型
| 接口类型 | 说明 | 方向 |
|---------|------|------|
| 上游接口 | 从其他系统获取数据 | ERP→MES |
| 下游接口 | 向其他系统推送数据 | MES→ERP |
| 双向接口 | 双向数据交换 | ↔ |
### 3.2 常用接口
**与ERP系统集成：**
| 接口名称 | 方向 | 数据内容 |
|---------|------|---------|
| 物料主数据 | ERP→MES | 物料信息、BOM、工艺 |
| 供应商主数据 | ERP→MES | 供应商信息 |
| 客户主数据 | ERP→MES | 客户信息 |
| 采购订单 | ERP→MES | 采购到货信息 |
| 生产工单 | ERP→MES | 生产工单 |
| 完工汇报 | MES→ERP | 工单完工信息 |
| 质量数据 | MES→ERP | 检验数据 |
| 库存数据 | MES→ERP | 库存数据 |
**与SCADA系统集成：**
| 接口名称 | 方向 | 数据内容 |
|---------|------|---------|
| 设备状态 | SCADA→MES | 设备运行状态 |
| 产量数据 | SCADA→MES | 实时产量 |
| 工艺参数 | SCADA→MES | 温度、压力等 |
| 报警信息 | SCADA→MES | 设备报警 |
| 生产指令 | MES→SCADA | 生产控制指令 |
### 3.3 接口配置
**接口配置要素：**
| 配置项 | 说明 |
|--------|------|
| 接口编码 | 接口唯一标识 |
| 接口名称 | 接口名称 |
| 接口类型 | API/中间库/消息 |
| 源系统 | 数据来源系统 |
| 目标系统 | 数据目标系统 |
| 接口地址 | API地址或数据库连接 |
| 认证方式 | 认证类型和凭证 |
| 数据格式 | JSON/XML/DB |
**接口配置示例：**
| 接口项 | 配置值 |
|--------|--------|
| 接口编码 | INT-001 |
| 接口名称 | 物料主数据同步 |
| 接口类型 | API |
| 源系统 | ERP |
| 目标系统 | MES |
| 接口地址 | http://erp-api/mdm/materials |
| 认证方式 | Token认证 |
| 调用频率 | 每日全量+实时增量 |
## 4. 数据同步
### 4.1 同步策略
| 同步策略 | 说明 | 触发方式 |
|---------|------|---------|
| 实时同步 | 数据变化即时同步 | 事件触发 |
| 定时同步 | 按计划定时同步 | 定时任务 |
| 手动同步 | 手工触发同步 | 人工操作 |
| 全量同步 | 全部数据同步 | 定时/手动 |
| 增量同步 | 仅同步变化数据 | 事件/定时 |
### 4.2 主数据同步
**物料数据同步：**
| 同步字段 | 说明 | 必填 |
|---------|------|------|
| 物料编码 | 物料唯一标识 | ✓ |
| 物料名称 | 物料名称 | ✓ |
| 规格型号 | 规格型号 | - |
| 计量单位 | 计量单位 | ✓ |
| 物料分类 | 物料类别 | - |
| 安全库存 | 安全库存量 | - |
| 采购周期 | 采购提前期 | - |
**BOM数据同步：**
| 同步字段 | 说明 | 必填 |
|---------|------|------|
| 产品编码 | 父项物料编码 | ✓ |
| 物料编码 | 子项物料编码 | ✓ |
| 用量 | 物料用量 | ✓ |
| 损耗率 | 损耗百分比 | - |
| 工序序号 | 物料使用的工序 | - |
### 4.3 业务数据同步
**工单数据同步：**
| 同步方向 | 数据内容 |
|---------|---------|
| ERP→MES | 工单编号、产品、数量、计划日期 |
| MES→ERP | 完工数量、完工时间、不良数量 |
**库存数据同步：**
| 同步方向 | 数据内容 |
|---------|---------|
| MES→ERP | 入库数量、出库数量、库存数量 |
## 5. 消息集成
### 5.1 消息类型
| 消息类型 | 说明 | 用途 |
|---------|------|------|
| 生产消息 | 生产相关事件 | 工单开工、完工等 |
| 质量消息 | 质量相关事件 | 检验完成、不良发生等 |
| 设备消息 | 设备相关事件 | 设备故障、报警等 |
| 库存消息 | 库存相关事件 | 入库、出库等 |
### 5.2 消息格式
**消息标准格式：**
```json
{
"messageId": "MSG-20260410-001",
"messageType": "PRODUCTION_START",
"sourceSystem": "MES",
"targetSystem": "ERP",
"timestamp": "2026-04-10 10:00:00",
"data": {
"workOrderId": "WO-001",
"productId": "P001",
"quantity": 1000,
"startTime": "2026-04-10 10:00:00"
}
}
```
### 5.3 消息处理
| 处理模式 | 说明 | 特点 |
|---------|------|------|
| 即时处理 | 消息立即处理 | 低延迟 |
| 异步处理 | 消息队列缓冲 | 高吞吐 |
| 批量处理 | 消息批量处理 | 高效率 |
## 6. 接口监控
### 6.1 监控指标
| 指标 | 说明 | 监控内容 |
|------|------|---------|
| 接口调用次数 | 接口调用统计 | 成功/失败次数 |
| 接口响应时间 | 接口响应速度 | 平均/最大响应时间 |
| 接口成功率 | 接口可用性 | 成功/总调用 |
| 数据同步时效 | 数据同步及时性 | 延迟时间 |
### 6.2 接口日志
| 日志类型 | 说明 | 保留时间 |
|---------|------|---------|
| 调用日志 | 接口调用记录 | 6个月 |
| 请求日志 | 请求报文记录 | 3个月 |
| 响应日志 | 响应报文记录 | 3个月 |
| 错误日志 | 错误信息记录 | 12个月 |
### 6.3 异常处理
| 异常类型 | 处理方式 |
|---------|---------|
| 网络异常 | 自动重试（3次） |
| 超时异常 | 增加超时时间 |
| 认证异常 | 重新获取Token |
| 数据异常 | 记录异常，人工处理 |
## 7. 数据转换
### 7.1 数据映射
**字段映射配置：**
| 源字段 | 目标字段 | 转换规则 |
|--------|---------|---------|
| material_code | mat_code | 直接映射 |
| unit_price | cost | 单位转换（元→万元） |
| create_time | createDate | 时间格式转换 |
### 7.2 数据校验
| 校验规则 | 说明 |
|---------|------|
| 必填校验 | 必填字段不能为空 |
| 格式校验 | 数据格式正确 |
| 长度校验 | 字段长度不超限 |
| 业务校验 | 业务规则校验 |
## 8. 集成安全
### 8.1 认证方式
| 认证方式 | 说明 | 安全性 |
|---------|------|--------|
| 用户名密码 | 基础认证 | 中 |
| API Key | 接口密钥 | 中 |
| Token认证 | OAuth2.0 | 高 |
| 数字证书 | SSL证书 | 高 |
### 8.2 传输安全
| 安全措施 | 说明 |
|---------|------|
| HTTPS | 数据传输加密 |
| 数据签名 | 数据完整性验证 |
| 数据脱敏 | 敏感数据保护 |
---
**数据与集成篇完**

366
docs/operation/system-operation.md Normal file
View File

@@ -0,0 +1,366 @@
# 系统运维
## 1. 功能概述
系统管理与运维模块为系统管理员提供系统的配置、管理和运维功能，确保系统的稳定运行。
**核心功能：**
| 功能 | 说明 |
|------|------|
| 系统参数配置 | 通用参数、业务参数 |
| 审批流程配置 | 审批流程定义 |
| 消息通知配置 | 通知渠道、模板 |
| 日志管理与审计 | 操作日志、安全日志 |
| 数据备份与恢复 | 备份策略、数据恢复 |
| 权限安全策略 | 密码策略、登录安全 |
## 2. 系统参数配置
### 2.1 通用参数
**系统信息配置：**
| 参数项 | 说明 | 默认值 |
|--------|------|--------|
| 系统名称 | 显示在系统标题 | HF-MES |
| 系统Logo | 登录页面Logo | - |
| 公司名称 | 系统所属公司 | - |
| 工作开始时间 | 默认上班时间 | 08:00 |
| 工作结束时间 | 默认下班时间 | 18:00 |
| 日期格式 | 日期显示格式 | YYYY-MM-DD |
| 时间格式 | 时间显示格式 | HH:mm:ss |
### 2.2 业务参数
**生产参数配置：**
| 参数项 | 说明 | 默认值 |
|--------|------|--------|
| 工序流转规则 | 顺序/并行 | 顺序 |
| 报工允许提前时间 | 报工可提前分钟数 | 10分钟 |
| 工单超期预警 | 提前预警天数 | 3天 |
| 报工允许滞后时间 | 报工可滞后分钟数 | 30分钟 |
**质量参数配置：**
| 参数项 | 说明 | 默认值 |
|--------|------|--------|
| 检验标准默认值 | 默认检验标准 | - |
| 批次号编码规则 | 批次号格式 | LOT-YYYYMMDD-XXX |
| 允收质量水平(AQL) | 默认AQL值 | 1.0 |
**设备参数配置：**
| 参数项 | 说明 | 默认值 |
|--------|------|--------|
| 点检提醒时间 | 提前提醒分钟数 | 30分钟 |
| 保养提醒时间 | 提前提醒天数 | 7天 |
| 设备OEE计算周期 | OEE统计周期 | 日/月 |
**【注意】** 修改系统参数可能影响业务运行，请谨慎操作。
## 3. 审批流程配置
### 3.1 审批流程定义
**流程要素：**
| 要素 | 说明 |
|------|------|
| 流程编码 | 流程唯一标识 |
| 流程名称 | 流程显示名称 |
| 流程类型 | 审批的业务类型 |
| 流程节点 | 审批环节 |
| 审批人 | 各环节审批人 |
| 流转规则 | 条件判断 |
### 3.2 流程类型
| 流程类型 | 说明 | 示例 |
|---------|------|------|
| 工单变更 | 工单信息变更审批 | 数量调整、延期 |
| 物料放行 | 物料特殊放行审批 | 让步接收 |
| 设备报损 | 设备报废审批 | 设备报废 |
| 不良处理 | 不良品处置审批 | MRB处理 |
| 补料审批 | 生产补料审批 | 物料追加 |
### 3.3 审批节点配置
**节点配置项：**
| 配置项 | 说明 |
|--------|------|
| 节点名称 | 审批环节名称 |
| 审批角色 | 审批人角色 |
| 审批人 | 具体审批人员 |
| 审批方式 | 会签/或签 |
| 时限要求 | 审批时限 |
| 超时处理 | 超时后处理方式 |
**审批方式：**
| 方式 | 说明 |
|------|------|
| 会签 | 所有审批人必须全部通过 |
| 或签 | 任意一个审批人通过即可 |
## 4. 消息通知配置
### 4.1 通知渠道
| 渠道类型 | 说明 | 配置要求 |
|---------|------|---------|
| 系统消息 | 系统内消息通知 | 内置 |
| 邮件通知 | 发送至邮箱 | 配置SMTP |
| 短信通知 | 发送至手机 | 配置短信网关 |
| 钉钉通知 | 钉钉企业消息 | 钉钉应用配置 |
| 企业微信 | 企业微信消息 | 企业微信配置 |
### 4.2 通知类型配置
| 业务事件 | 通知类型 | 接收人 |
|---------|---------|--------|
| 工单下發 | 系统消息/邮件 | 车间主管 |
| 工单完工 | 系统消息 | 计划员 |
| 质量异常 | 系统消息/短信 | 质量工程师 |
| 设备故障 | 系统消息/短信 | 设备工程师 |
| 库存不足 | 系统消息/邮件 | 仓管员 |
| 审批待办 | 系统消息/邮件 | 审批人 |
### 4.3 通知模板
**模板配置项：**
| 配置项 | 说明 |
|--------|------|
| 模板编码 | 模板唯一标识 |
| 模板名称 | 模板名称 |
| 通知渠道 | 发送渠道 |
| 标题模板 | 消息标题 |
| 内容模板 | 消息内容 |
**模板变量：**
| 变量 | 说明 |
|------|------|
| ${工单编号} | 工单编号 |
| ${产品名称} | 产品名称 |
| ${数量} | 数量 |
| ${时间} | 时间 |
| ${审批人} | 审批人姓名 |
## 5. 日志管理与审计
### 5.1 日志类型
| 日志类型 | 说明 | 保留时间 |
|---------|------|---------|
| 操作日志 | 用户操作记录 | 6个月 |
| 系统日志 | 系统运行日志 | 3个月 |
| 接口日志 | 接口调用日志 | 6个月 |
| 异常日志 | 异常错误日志 | 12个月 |
| 安全日志 | 登录安全日志 | 12个月 |
### 5.2 操作日志内容
| 记录项 | 说明 |
|--------|------|
| 操作时间 | 操作发生时间 |
| 用户账号 | 执行操作的用户 |
| 用户姓名 | 用户姓名 |
| 操作类型 | 操作类别 |
| 操作内容 | 具体操作描述 |
| 操作对象 | 操作的数据对象 |
| IP地址 | 操作人IP地址 |
| 结果 | 成功/失败 |
### 5.3 日志查询
**查询条件：**
| 查询维度 | 可选条件 |
|---------|---------|
| 时间范围 | 开始时间-结束时间 |
| 用户 | 操作人员 |
| 操作类型 | 新增/修改/删除等 |
| 操作模块 | 功能模块 |
| 操作结果 | 成功/失败 |
### 5.4 审计报表
| 报表类型 | 说明 |
|---------|------|
| 用户操作统计 | 各用户操作频次 |
| 模块操作统计 | 各模块操作统计 |
| 异常操作统计 | 失败操作统计 |
| 登录审计 | 登录情况审计 |
## 6. 数据备份与恢复
### 6.1 备份策略
| 备份类型 | 执行频率 | 保留份数 | 说明 |
|---------|---------|---------|------|
| 全量备份 | 每周 | 4份 | 每周一次完整备份 |
| 增量备份 | 每日 | 7份 | 每日备份增量数据 |
| 实时备份 | 实时 | - | 数据库日志备份 |
### 6.2 备份配置
**备份任务配置：**
| 配置项 | 说明 |
|--------|------|
| 任务名称 | 备份任务名称 |
| 备份类型 | 全量/增量 |
| 执行时间 | 备份执行时间 |
| 存储位置 | 备份文件存放位置 |
| 保留策略 | 备份保留份数 |
| 压缩方式 | 是否压缩 |
### 6.3 手动备份
**操作步骤：**
1. 进入【系统管理】→【数据备份】
2. 点击【手动备份】
3. 选择备份类型
4. 点击【开始备份】
5. 系统执行备份
6. 完成后显示备份文件
### 6.4 数据恢复
**恢复操作步骤：**
1. 进入【系统管理】→【数据恢复】
2. 选择恢复时间点
3. 选择备份文件
4. 确认恢复信息
5. 确认恢复（需输入确认码）
6. 系统执行恢复
7. 恢复完成后重启服务
**【重要】** 数据恢复会覆盖当前数据，请确保已做好当前数据备份！
## 7. 权限安全策略
### 7.1 密码策略
| 策略项 | 配置值 | 说明 |
|--------|--------|------|
| 最小长度 | 8位 | 密码最少位数 |
| 复杂度要求 | 必须包含字母和数字 | 复杂度规则 |
| 有效期 | 90天 | 密码有效天数 |
| 过期提醒 | 7天 | 过期前提醒 |
| 历史密码 | 5个 | 不能重复使用 |
| 尝试次数 | 5次 | 错误次数限制 |
| 锁定时间 | 30分钟 | 账户锁定时间 |
### 7.2 登录安全
| 配置项 | 说明 |
|--------|------|
| 允许同时登录 | 是/否 |
| 会话超时时间 | 30分钟 |
| IP白名单 | 允许登录的IP |
| IP黑名单 | 禁止登录的IP |
| 异地登录提醒 | 是/否 |
### 7.3 数据权限
**数据权限级别：**
| 权限级别 | 说明 |
|---------|------|
| 全部数据 | 可查看所有数据 |
| 工厂级 | 只能查看所属工厂数据 |
| 车间级 | 只能查看所属车间数据 |
| 产线级 | 只能查看所属产线数据 |
| 个人数据 | 只能查看自己的数据 |
## 8. 系统性能监控
### 8.1 监控指标
| 指标类别 | 具体指标 | 正常范围 |
|---------|---------|---------|
| 服务器性能 | CPU使用率 | < 80% |
| 服务器性能 | 内存使用率 | < 85% |
| 服务器性能 | 磁盘使用率 | < 90% |
| 数据库性能 | 连接数 | < 连接池上限 |
| 数据库性能 | 查询响应时间 | < 1秒 |
| 应用性能 | API响应时间 | < 3秒 |
| 应用性能 | 并发用户数 | < 许可数量 |
### 8.2 监控面板
**监控面板展示：**
```
┌─────────────────────────────────────────────────────────────┐
│ 系统监控面板 │
├─────────────────────────────────────────────────────────────┤
│ │
│ 服务器状态 │
│ ┌───────────────┐ ┌───────────────┐ ┌───────────────┐ │
│ │ CPU │ │ 内存 │ │ 磁盘 │ │
│ │ 45.2% │ │ 68.5% │ │ 52.3% │ │
│ └───────────────┘ └───────────────┘ └───────────────┘ │
│ │
│ 应用服务状态 │
│ ┌───────────────┐ ┌───────────────┐ ┌───────────────┐ │
│ │ Web服务 │ │ API服务 │ │ 定时服务 │ │
│ │ 正常 │ │ 正常 │ │ 正常 │ │
│ └───────────────┘ └───────────────┘ └───────────────┘ │
│ │
│ 数据库状态 │
│ ┌───────────────┐ ┌───────────────┐ ┌───────────────┐ │
│ │ 连接数 │ │ 活跃会话 │ │ 查询响应 │ │
│ │ 45/200 │ │ 12 │ │ 0.5秒 │ │
│ └───────────────┘ └───────────────┘ └───────────────┘ │
│ │
└─────────────────────────────────────────────────────────────┘
```
### 8.3 告警配置
| 告警项 | 告警条件 | 告警方式 |
|--------|---------|---------|
| CPU过高 | > 90% | 短信/邮件 |
| 内存过高 | > 95% | 短信/邮件 |
| 磁盘空间不足 | < 10% | 短信/邮件 |
| 服务宕机 | 服务停止 | 短信/电话 |
| 数据库连接满 | 100% | 短信/电话 |
## 9. 版本升级
### 9.1 升级流程
```
备份数据 → 下载升级 → 执行升级 → 验证功能 → 发布上线
```
### 9.2 升级前检查
| 检查项 | 说明 |
|--------|------|
| 数据备份 | 确认数据已备份 |
| 环境检查 | 服务器环境符合要求 |
| 兼容性检查 | 确认升级包兼容 |
| 停机通知 | 通知相关人员 |
| 回滚方案 | 准备回滚方案 |
### 9.3 升级后验证
| 验证项 | 说明 |
|--------|------|
| 服务启动 | 确认服务正常运行 |
| 功能验证 | 验证核心功能 |
| 数据验证 | 确认数据完整性 |
| 性能验证 | 确认系统性能正常 |
---
**系统运维篇完**

459
docs/operation/technical-support.md Normal file
View File

@@ -0,0 +1,459 @@
# 异常处理与技术支持
## 1. 功能概述
本章为用户提供常见问题的解决方案和获取技术支持的渠道，帮助用户快速解决使用过程中遇到的问题。
**主要内容：**
| 内容 | 说明 |
|------|------|
| 常见问题FAQ | 各类常见问题解答 |
| 系统错误码说明 | 错误码及解决方案 |
| 故障排查指南 | 问题排查方法 |
| 技术支持联系方式 | 获取支持的渠道 |
## 2. 常见问题FAQ
### 2.1 登录相关问题
**Q1: 登录提示"用户名或密码错误"**
| 可能原因 | 解决方案 |
|---------|---------|
| 输入错误 | 检查用户名和密码是否正确 |
| 大小写问题 | 检查是否开启了大小写敏感 |
| 键盘问题 | 确认Caps Lock未开启 |
**Q2: 登录提示"账户已锁定"**
| 可能原因 | 解决方案 |
|---------|---------|
| 多次登录失败 | 等待30分钟后自动解锁或联系管理员 |
| 账户被禁用 | 联系系统管理员启用账户 |
**Q3: 登录提示"无访问权限"**
| 可能原因 | 解决方案 |
|---------|---------|
| 未分配角色 | 联系管理员分配权限 |
| 角色权限不足 | 申请更高权限 |
| IP限制 | 检查是否在允许的IP范围内 |
**Q4: 忘记密码怎么办？**
| 解决方案 | 操作方式 |
|---------|---------|
| 自助找回 | 点击登录页"忘记密码"，通过邮箱/手机重置 |
| 管理员重置 | 联系系统管理员重置密码 |
### 2.2 生产管理相关问题
**Q5: 无法创建工单？**
| 可能原因 | 解决方案 |
|---------|---------|
| 缺少产品BOM | 先维护产品BOM |
| 缺少工艺路线 | 先维护工艺路线 |
| 物料未齐套 | 确认物料库存充足 |
| 权限不足 | 联系管理员开通权限 |
**Q6: 工单无法下发？**
| 可能原因 | 解决方案 |
|---------|---------|
| 物料未齐套 | 检查物料库存 |
| 产线不可用 | 检查产线状态 |
| 工艺路线未维护 | 维护工艺路线 |
| 计划日期冲突 | 调整计划日期 |
**Q7: 报工数据无法保存？**
| 可能原因 | 解决方案 |
|---------|---------|
| 工序未开工 | 先执行开工报工 |
| 数据格式错误 | 检查输入数据格式 |
| 数量超出范围 | 确认数量在允许范围内 |
| 会话超时 | 重新登录 |
### 2.3 质量管理相关问题
**Q8: 检验项目无法添加？**
| 可能原因 | 解决方案 |
|---------|---------|
| 检验标准未维护 | 先创建检验标准 |
| 权限不足 | 联系管理员授权 |
| 数据格式错误 | 检查输入格式 |
**Q9: 不良品如何处理？**
| 处理方式 | 说明 |
|---------|------|
| 返工 | 将不良品返回工序重新加工 |
| 降级使用 | 降低产品等级使用 |
| 让步接收 | 经审批后特殊放行 |
| 报废 | 办理报废手续 |
**Q10: 批次追溯查询无结果？**
| 可能原因 | 解决方案 |
|---------|---------|
| 批次号输入错误 | 核对批次号 |
| 批次未纳入追溯 | 确认物料是否批次管理 |
| 数据未同步 | 联系管理员检查数据 |
### 2.4 设备管理相关问题
**Q11: 点检任务未生成？**
| 可能原因 | 解决方案 |
|---------|---------|
| 设备未配置点检标准 | 为设备配置点检标准 |
| 日期不在点检周期 | 确认点检周期配置 |
| 点检标准未启用 | 启用点检标准 |
**Q12: 设备故障如何报修？**
| 操作步骤 | 说明 |
|---------|------|
| 1. 发现故障 | 发现设备异常 |
| 2. 紧急评估 | 评估是否需要紧急停机 |
| 3. 提交报修 | 在设备管理中提交报修单 |
| 4. 维修处理 | 等待维修人员处理 |
| 5. 验收确认 | 维修完成后确认 |
### 2.5 仓储物流相关问题
**Q13: 入库单无法确认？**
| 可能原因 | 解决方案 |
|---------|---------|
| IQC未完成 | 完成来料检验 |
| 批次号重复 | 修改批次号 |
| 库位不可用 | 选择其他库位 |
**Q14: 库存数据不准确？**
| 可能原因 | 解决方案 |
|---------|---------|
| 单据未审核 | 审核相关单据 |
| 盘点差异 | 执行库存盘点 |
| 数据同步问题 | 联系管理员检查 |
**Q15: 如何进行库存盘点？**
| 操作步骤 | 说明 |
|---------|------|
| 1. 创建盘点单 | 选择仓库和物料 |
| 2. 执行盘点 | 现场清点数量 |
| 3. 录入实盘 | 输入实际数量 |
| 4. 差异审核 | 审核盘点差异 |
| 5. 账务调整 | 调整库存账务 |
### 2.6 系统操作相关问题
**Q16: 页面显示不完整？**
| 解决方案 | 操作方式 |
|---------|---------|
| 清除缓存 | 清除浏览器缓存 |
| 更换浏览器 | 使用推荐的浏览器 |
| 调整缩放 | 调整浏览器缩放比例 |
| 检查分辨率 | 确保屏幕分辨率达标 |
**Q17: 数据导出失败？**
| 可能原因 | 解决方案 |
|---------|---------|
| 数据量过大 | 分批导出 |
| 网络问题 | 检查网络连接 |
| 权限不足 | 联系管理员授权 |
| 格式不支持 | 更换导出格式 |
**Q18: 审批流程无法流转？**
| 可能原因 | 解决方案 |
|---------|---------|
| 审批人未配置 | 配置审批人 |
| 条件不满足 | 检查流转条件 |
| 审批人不在线 | 提醒审批人 |
## 3. 系统错误码说明
### 3.1 错误码分类
| 错误码范围 | 错误类型 | 说明 |
|-----------|---------|------|
| 1000-1999 | 基础错误 | 系统基础错误 |
| 2000-2999 | 权限错误 | 权限相关错误 |
| 3000-3999 | 业务错误 | 业务逻辑错误 |
| 4000-4999 | 数据错误 | 数据验证错误 |
| 5000-5999 | 接口错误 | 外部接口错误 |
| 9000-9999 | 系统错误 | 系统内部错误 |
### 3.2 权限类错误
| 错误码 | 错误信息 | 解决方案 |
|--------|---------|---------|
| 2001 | 无访问权限 | 联系管理员开通权限 |
| 2002 | 权限不足 | 申请更高权限 |
| 2003 | 角色未分配 | 联系管理员分配角色 |
| 2004 | 会话过期 | 重新登录系统 |
| 2005 | IP限制访问 | 在允许的IP范围内访问 |
### 3.3 业务类错误
| 错误码 | 错误信息 | 解决方案 |
|--------|---------|---------|
| 3001 | 数据已存在 | 检查是否重复创建 |
| 3002 | 数据不存在 | 检查数据是否正确 |
| 3003 | 状态不允许操作 | 确认当前状态可执行操作 |
| 3004 | 数量超出范围 | 调整数量在允许范围内 |
| 3005 | 业务规则校验失败 | 检查是否符合业务规则 |
| 3006 | 关联数据不存在 | 检查关联数据是否完整 |
| 3007 | 数据被引用 | 解除数据引用关系后再操作 |
### 3.4 数据类错误
| 错误码 | 错误信息 | 解决方案 |
|--------|---------|---------|
| 4001 | 必填字段为空 | 填写必填字段 |
| 4002 | 数据格式错误 | 检查数据格式 |
| 4003 | 字段长度超限 | 缩短输入内容 |
| 4004 | 数据类型不匹配 | 输入正确类型数据 |
| 4005 | 日期格式错误 | 使用正确的日期格式 |
| 4006 | 编码重复 | 使用不重复的编码 |
### 3.5 接口类错误
| 错误码 | 错误信息 | 解决方案 |
|--------|---------|---------|
| 5001 | 接口连接超时 | 检查网络连接 |
| 5002 | 接口服务不可用 | 联系接口服务方 |
| 5003 | 接口认证失败 | 检查接口认证信息 |
| 5004 | 接口返回错误 | 查看接口返回信息 |
| 5005 | 数据同步失败 | 检查数据同步配置 |
### 3.6 系统类错误
| 错误码 | 错误信息 | 解决方案 |
|--------|---------|---------|
| 9001 | 系统繁忙 | 稍后重试 |
| 9002 | 操作失败 | 重试或联系管理员 |
| 9003 | 服务器错误 | 联系技术支持 |
| 9004 | 数据库错误 | 联系技术支持 |
| 9005 | 内存不足 | 重启服务或扩容 |
## 4. 故障排查指南
### 4.1 登录故障排查
**排查流程：**
```
开始
│
▼
登录失败？
│
├─── 是 ───→ 检查错误提示
│ │
│ ▼
│ ┌─────────┐
│ │ 错误码？ │
│ └────┬────┘
│ │
│ ┌─────────┼─────────┐
│ │ │ │
│ ▼ ▼ ▼
│ 权限类 业务类 系统类
│ 错误 错误 错误
│ │ │ │
│ │ │ ▼
│ │ │ 重试/联系技术支持
│ │
│检查用户状态/权限
│
└─── 否 ───→ 排查完成
```
### 4.2 性能问题排查
**排查项目：**
| 检查项 | 检查方法 | 正常范围 |
|--------|---------|---------|
| CPU使用率 | 任务管理器查看 | < 80% |
| 内存使用率 | 任务管理器查看 | < 85% |
| 磁盘IO | 性能监控查看 | < 70% |
| 网络延迟 | ping命令测试 | < 100ms |
| 数据库连接 | 查看连接池 | < 最大值 |
| 慢查询 | 查看查询日志 | < 1秒 |
**常见性能问题：**
| 问题现象 | 可能原因 | 解决方案 |
|---------|---------|---------|
| 页面加载慢 | 网络问题/服务器负载高 | 检查网络/扩容 |
| 操作响应慢 | 数据库查询慢 | 优化索引/增加资源 |
| 报表生成慢 | 数据量大 | 分批查询/优化SQL |
| 批量操作慢 | 逐条处理 | 改为批量处理 |
### 4.3 数据问题排查
**数据一致性检查：**
| 检查项 | 检查方法 | 处理方式 |
|--------|---------|---------|
| 库存账实不符 | 盘点核对 | 差异审核调整 |
| 批次追溯断裂 | 查询追溯链 | 检查数据录入 |
| 工单状态异常 | 查看工单日志 | 修正状态 |
| 检验数据缺失 | 查看检验记录 | 补录数据 |
### 4.4 接口问题排查
**排查步骤：**
1. 检查接口配置
2. 验证认证信息
3. 测试网络连通性
4. 检查接口日志
5. 验证数据格式
6. 联系接口提供方
## 5. 日志提取指南
### 5.1 日志类型
| 日志类型 | 存储位置 | 用途 |
|---------|---------|------|
| 操作日志 | /logs/operation/ | 追踪用户操作 |
| 错误日志 | /logs/error/ | 排查系统错误 |
| 接口日志 | /logs/interface/ | 排查接口问题 |
| 数据库日志 | /logs/database/ | 排查数据问题 |
| 应用日志 | /logs/application/ | 排查应用问题 |
### 5.2 日志提取方法
**方法一：通过系统导出**
1. 进入【系统管理】→【日志管理】
2. 选择日志类型
3. 设置查询条件
4. 点击【导出】
5. 下载日志文件
**方法二：通过服务器访问**
```bash
# 访问日志目录
cd /opt/mes/logs
# 查看最近的错误日志
tail -n 100 error.log
# 搜索指定关键词
grep "error" error.log
# 导出指定时间段的日志
grep "2026-04-10" error.log > error_20260410.log
```
### 5.3 日志提取注意事项
- 【注意】日志提取可能包含敏感信息，请注意保密
- 【提示】提供日志时请注明问题发生的时间范围
- 【重要】请在问题复现时同步提取日志
## 6. 问题上报指南
### 6.1 问题分类
| 问题级别 | 定义 | 响应时间 | 解决时间 |
|---------|------|---------|---------|
| 紧急 | 系统不可用、业务中断 | 1小时 | 4小时 |
| 高 | 核心功能异常 | 4小时 | 24小时 |
| 中 | 一般功能异常 | 8小时 | 72小时 |
| 低 | 界面/体验问题 | 24小时 | 1周 |
### 6.2 问题描述模板
请按以下模板描述问题：
```
【问题描述】
1. 问题现象：描述遇到的问题
2. 期望行为：期望的正确行为
3. 实际行为：实际发生的错误
【问题环境】
- 模块：xxx
- 页面：xxx
- 浏览器：xxx
- 操作系统：xxx
【复现步骤】
1.
2.
3.
【错误信息】
（错误提示截图或文字）
【附件】
- 截图
- 日志
- 相关数据
```
## 7. 技术支持联系方式
### 7.1 常规支持
| 联系方式 | 信息 |
|---------|------|
| 服务热线 | 400-XXX-XXXX |
| 服务邮箱 | support@hfmes.com |
| 服务时间 | 周一至周五 9:00-18:00 |
| 紧急电话 | 138-XXXX-XXXX |
### 7.2 在线支持
| 渠道 | 说明 |
|------|------|
| 企业微信群 | 专属服务群 |
| 在线工单 | 提交技术支持工单 |
| 远程协助 | TeamViewer远程支持 |
### 7.3 服务承诺
| 服务类型 | 承诺内容 |
|---------|---------|
| 响应时间 | 紧急问题1小时内响应 |
| 问题解决 | 承诺时间内给出解决方案 |
| 服务态度 | 专业、耐心、负责任 |
| 信息安全 | 严格保密客户数据 |
## 8. 版本与更新
### 8.1 版本信息
| 版本号 | 发布日期 | 更新内容 |
|--------|---------|---------|
| v5.0 | 2026-04-10 | 初始版本发布 |
| - | - | - |
### 8.2 更新订阅
**订阅方式：**
| 订阅渠道 | 说明 |
|---------|------|
| 系统消息 | 登录系统查看更新公告 |
| 邮件订阅 | 订阅版本更新邮件 |
| 企业微信 | 加入服务群获取通知 |
---
**异常处理与技术支持篇完**

117
docs/格式标准.md Normal file
View File

@@ -0,0 +1,117 @@
# 一、文档结构层级规范
## 1.1 标题层级定义
- 一级标题 ：文档主标题，用于封面标识，格式为 # 文档名称
- 页面标题 ：每个页面的标题，对应单独一个md文件 格式为 # 页面标题
- 页面一级标题 ：页面内一级标题，标识主要章节内容、核心业务模块，格式为 ## X. 模块名称
- 页面二级标题 ：页面内二级标题，功能节标题，标识具体功能点，格式为 ### X.X 功能名称
- 页面三级标题 ：页面内三级标题，细节标题，用于细分功能内的具体内容，格式为 #### X.X.X 详细内容
- 特殊加强 : 针对特殊加强部分，可以使用 **功能标题：** 进行特殊加强
# 二、标题块书写标准
## 2.1 功能概述块标准格式
每个功能模块的开篇应包含功能概述块，采用以下标准格式：
```text
**核心功能：**
- 功能点一
- 功能点二
- 功能点三
```
概述内容应简洁明了，通常列出3至6个核心功能点，使用无序列表呈现。概述块放置于功能节标题之后、正文内容之前。
## 2.2 术语说明块标准格式
涉及专业术语的章节应包含术语说明块，采用表格形式呈现：
```text
#### X.X.X 术语说明
| 术语 | 定义 | 说明 |
|------|------|------|
| 术语一 | 术语一定义 | 补充说明 |
| 术语二 | 术语二定义 | 补充说明 |
```
表格应包含术语、定义、说明三列，定义列应简洁准确，说明列提供必要的上下文信息。
# 三、操作说明块书写标准
## 3.1 操作步骤标准格式
操作说明应采用编号列表形式，基本格式如下：
```text
**操作步骤：**
1. 进入【菜单路径】→【子菜单】
2. 点击【操作按钮】
3. 填写表单信息
4. 点击【确认】完成操作
```
操作步骤应遵循以下规范：每个步骤以动词开头（如进入、点击、填写、选择、确认等）；菜单路径使用【】包裹；按钮名称使用【】包裹；操作说明使用祈使句式；步骤编号连续不间断。
## 3.2 字段说明表格标准格式
操作中涉及的表单字段应使用标准表格进行说明：
```text
| 字段 | 说明 | 必填 |
|------|------|------|
| 字段一 | 字段一的含义和填写要求 | 是 |
| 字段二 | 字段二的含义和填写要求 | 否 |
```
表格必须包含字段、说明、必填三列。必填列使用“是”或“否”标识。说明列应详细描述字段的用途、格式要求、取值范围等信息。对于需要自动生成的字段，在必填列标注“-”或说明“系统自动生成”。
## 3.3 提示与注意事项标注规范
文档中应使用统一的标注符号系统来提示不同类型的信息：
- 【重要】 ：用于标识关键操作点或不可逆操作，如“【重要】删除操作不可恢复，请谨慎操作”
- 【注意】 ：用于标识常见的操作误区或需要特别关注的事项，如“【注意】修改BOM版本会影响新的工单”
- 【提示】 ：用于提供便于操作的技巧或建议，如“【提示】建议使用移动端进行扫码操作”
这些标注应放置于相关操作说明的末尾或独立成段，使用加粗格式以突出显示。
## 3.4 查询条件与结果说明规范
涉及查询功能的操作应包含查询条件说明：
```text
**查询条件：**
| 查询条件 | 说明 |
|---------|------|
| 条件一 | 条件一的含义 |
| 条件二 | 条件二的选择方式 |
```
查询结果应描述系统的返回内容和展示方式，必要时使用表格或图示说明结果字段的含义。
# 四、截图说明块书写标准
## 4.1 界面示意图绘制规范
图片名称或说明用 **图片说明** 放置在图片插入点上方
```text
**操作示意图：**
xxxxxx[图片]
```
# 五、流程说明块书写标准
5.1 流程图规范
所有文档中的流程图，均使用mermaid语法绘制。
如果涉及到mermaid无法表述的复杂图表，使用SVG方式进行嵌入，并确保SVG来源于Draw.IO绘制导出的标准SVG格式。
# 六、文档样例
> 查阅 格式样例.md 文件

325
docs/格式样例.md Normal file
View File

@@ -0,0 +1,325 @@
# 查询追溯
## 1. 功能概述
质量追溯模块实现从原材料到成品的全流程正向追溯，以及从成品到原材料的逆向追溯，支持快速定位问题、精准召回和持续改进。
**核心功能：**
- 正向追溯：从原材料批次出发，追踪其在生产过程中的流转路径，最终追溯到使用的成品批次及出货去向
- 逆向追溯：从成品批次或客户投诉出发，反向追溯到原材料供应商，实现问题快速定位
- 生产过程追溯：记录和追溯每个生产工序的作业人员、设备参数、开工完工时间等详细信息
- 质量数据追溯：关联检验记录、不良品处理记录，为质量问题分析提供完整数据支撑
- 供应链追溯：串联供应商信息、物流信息、仓储信息，构建完整的供应链追溯链条
- 追溯报告生成：支持一键生成追溯报告，导出 PDF 或 Excel 格式便于存档和交接
## 2. 术语说明
#### 2.1.1 追溯相关术语
| 术语 | 定义 | 说明 |
|------|------|------|
| 正向追溯 | Forward Trace，从原材料到成品的追溯方向 | 又称顺着物料流向追溯 |
| 逆向追溯 | Reverse Trace，从成品到原材料的追溯方向 | 又称反着物料流向追溯 |
| 批次号 | Batch/Lot Number，物料或产品的唯一标识 | 格式通常为 LOT-YYYYMMDD-XXX |
| 工序追溯 | Process Trace，对生产过程中各工序的追溯 | 记录人员、设备、时间等信息 |
| 物料清单 | BOM，Bill of Materials，产品构成清单 | 包含子物料及其用量比例 |
## 3. 追溯类型
### 3.1 正向追溯
正向追溯是指从原材料批次出发，按照生产加工路径，顺向追踪物料的流转过程，最终追溯到使用该物料生产的成品批次及其出货记录。
**典型应用场景：**
- 原材料出现质量问题时，快速定位受影响的所有成品批次
- 供应商物料存在安全隐患时，进行精准召回
- 生产异常排查时，分析物料在生产环节的影响范围
**正向追溯数据链：**
```mermaid
flowchart LR
A[原材料批次] --> B[来料检验]
B --> C[物料入库]
C --> D[生产领料]
D --> E[工序加工]
E --> F[半成品/成品]
F --> G[成品入库]
G --> H[出货检验]
H --> I[成品出货]
I --> J[客户接收]
```
### 3.2 逆向追溯
逆向追溯是指从成品批次或客户反馈出发，反向追踪产品的构成物料及其来源，实现问题的快速定位和原因分析。
**典型应用场景：**
- 客户投诉成品质量问题时，反向排查原因
- 成品出现质量异常时，定位责任环节和物料
- 定期质量分析时，构建完整的产品质量档案
**逆向追溯数据链：**
```mermaid
flowchart RL
A[成品批次] --> B[成品检验记录]
A --> C[生产工单]
C --> D[领料记录]
D --> E[物料批次]
E --> F[IQC检验记录]
E --> G[供应商信息]
F --> H[质量问题分析]
```
### 3.3 生产过程追溯
生产过程追溯聚焦于工单执行过程中的详细信息，包括作业人员、设备状态、工艺参数、报工记录等。
**追溯内容：**
| 追溯要素 | 追溯内容 | 数据来源 |
|---------|---------|---------|
| 工单信息 | 工单编号、产品型号、计划数量、开工完工时间 | 生产工单 |
| 工序信息 | 工序名称、工序顺序、作业内容 | 工艺路线 |
| 作业人员 | 人员姓名、工号、班组 | 报工记录 |
| 设备信息 | 设备编号、设备名称、设备状态 | 设备报工 |
| 工艺参数 | 温度、压力、速度、时间等 | 参数采集 |
| 产量数据 | 合格数量、不良数量、报废数量 | 报工记录 |
## 4. 追溯查询操作
### 4.1 追溯条件设置
**查询条件：**
| 查询条件 | 说明 |
|---------|------|
| 追溯类型 | 选择"正向追溯"或"逆向追溯" |
| 追溯标识 | 输入批次号，支持模糊查询 |
| 追溯日期范围 | 选择追溯数据的时间范围 |
| 产品范围 | 选择需要追溯的产品范围 |
| 追溯深度 | 选择追溯层级：简单/详细/完整 |
### 4.2 正向追溯查询
**操作步骤：**
1. 进入【质量管理】→【质量追溯】→【正向追溯】
2. 在追溯类型下拉框中选择"正向追溯"
3. 在批次号输入框中输入物料批次号，例如：LOT-20260410-001
4. 选择追溯日期范围，系统默认显示最近 30 天数据
5. 点击【开始追溯】按钮
6. 系统自动展开追溯链路，展示完整的物料流转路径
**追溯结果展示：**
| 层级 | 追溯对象 | 数量 | 时间 | 状态 |
|------|---------|------|------|------|
| 1 | 原材料批次 LOT-20260410-001 | 1000 PCS | 2026-04-10 | 已检验合格 |
| 2 | 入库单 RK-20260410-001 | 1000 PCS | 2026-04-10 | 已入库 |
| 3 | 领料单 LL-20260412-001 | 200 PCS | 2026-04-12 | 已领料 |
| 4 | 工单 WO-20260412-001 | 200 PCS | 2026-04-12 | 生产中 |
| 5 | 成品批次 LOT-F-20260413-001 | 198 PCS | 2026-04-13 | 待检验 |
**【提示】** 点击追溯对象可展开详细信息，如查看检验记录、工序作业记录等。
### 4.3 逆向追溯查询
**操作步骤：**
1. 进入【质量管理】→【质量追溯】→【逆向追溯】
2. 在追溯类型下拉框中选择"逆向追溯"
3. 输入成品批次号或客户投诉单号
4. 点击【开始追溯】按钮
5. 系统自动反向展开追溯链路
**追溯结果展示：**
| 层级 | 追溯对象 | 数量 | 时间 | 责任方 |
|------|---------|------|------|--------|
| 1 | 成品批次 LOT-F-20260413-001 | 500 PCS | 2026-04-13 | 某客户 |
| 2 | 出货记录 SO-20260415-001 | 500 PCS | 2026-04-15 | 某客户 |
| 3 | 成品检验记录 FQC-20260413-001 | 500 PCS | 2026-04-13 | FQC组 |
| 4 | 工单 WO-20260412-001 | 500 PCS | 2026-04-12 | SMT车间 |
| 5 | 领料记录 LOT-20260410-001 | 100 PCS | 2026-04-12 | 仓库 |
| 6 | IQC检验记录 IQC-20260410-001 | 1000 PCS | 2026-04-10 | IQC组 |
| 7 | 供应商 深圳市华星电子有限公司 | 1000 PCS | - | 供应商 |
**【重要】** 逆向追溯结果中的供应商信息仅作为参考，实际责任认定需结合质量分析报告。
### 4.4 追溯深度设置
| 追溯深度 | 说明 | 适用场景 |
|---------|------|---------|
| 简单追溯 | 仅显示批次流转路径 | 快速确认物料流向 |
| 详细追溯 | 显示批次流转及关键节点信息 | 日常质量排查 |
| 完整追溯 | 显示完整数据链，包括人员、设备、参数等 | 深度问题分析 |
## 5. 追溯详细信息
### 5.1 工序作业详情
当追溯到某个工单时，可以展开查看该工单下各工序的详细作业信息。
**操作示意图：**
**工序作业详情：**
[图片：工序作业详情界面]
工序作业详情包含以下内容：
1. **工序列表**：展示工单涉及的所有工序
2. **作业人员**：执行该工序的具体人员
3. **设备信息**：使用的生产设备及状态
4. **工艺参数**：关键工艺参数的实际值
5. **产量记录**：合格数、不良数、报废数
**字段说明：**
| 字段 | 说明 | 必填 |
|------|------|------|
| 工序序号 | 工序在工艺路线中的顺序号 | - |
| 工序名称 | 工序的名称，如 SMT、焊接、组装等 | 是 |
| 开工时间 | 工序开始作业的时间 | 是 |
| 完工时间 | 工序完成作业的时间 | 是 |
| 作业人员 | 执行该工序的作业人员姓名 | 是 |
| 设备编号 | 使用设备的唯一编号 | 否 |
| 合格数量 | 本工序生产的合格品数量 | 是 |
| 不良数量 | 本工序产生的不良品数量 | 是 |
| 报废数量 | 本工序报废的数量 | 是 |
### 5.2 检验记录详情
追溯过程中可以查看相关的质量检验记录，包括 IQC、IPQC、FQC 等各类检验数据。
**字段说明：**
| 字段 | 说明 | 必填 |
|------|------|------|
| 检验单号 | 检验记录的唯一编号 | - |
| 检验类型 | IQC/IPQC/FQC/OQC | 是 |
| 检验批次 | 被检验的物料或产品批次 | 是 |
| 抽样数量 | 按抽样方案抽取的检验数量 | 是 |
| 合格数量 | 检验合格的数量 | 是 |
| 不良数量 | 检验不合格的数量 | 是 |
| 合格率 | 合格数量/抽样数量×100% | - |
| 检验结论 | 合格/让步接收/拒收 | 是 |
| 检验员 | 执行检验的人员 | 是 |
| 检验时间 | 执行检验的时间 | 是 |
### 5.3 不良品记录详情
追溯过程中可以查看产生的不良品记录，包括不良类型、原因分析及处理结果。
**字段说明：**
| 字段 | 说明 | 必填 |
|------|------|------|
| 不良单号 | 不良品记录的唯一编号 | - |
| 不良批次 | 产生不良的批次号 | 是 |
| 不良数量 | 不良品数量 | 是 |
| 不良类型 | 外观不良/尺寸不良/功能不良/性能不良/安全不良 | 是 |
| 不良位置 | 不良发生的具体位置 | 否 |
| 不良原因 | 产生不良的原因分析 | 是 |
| 处理方式 | 返工/降级/报废/让步接收 | 是 |
| 处理结果 | 实际的处置结果 | 是 |
| 责任人 | 对不良负责的人员或部门 | 否 |
**【注意】** 不良品记录的完整性和准确性直接影响追溯分析的有效性，请确保在发现不良时及时登记。
## 6. 追溯报告生成
### 6.1 报告生成操作
追溯完成后，可以将追溯结果生成为正式的报告文档，便于存档和交接。
**操作步骤：**
1. 在追溯结果页面，点击【生成报告】按钮
2. 选择报告格式：PDF / Excel / Word
3. 选择报告模板：简洁版 / 标准版 / 详细版
4. 填写报告信息：
- 报告标题
- 追溯原因：如"客户投诉追溯"、"质量问题追溯"
- 编制人
- 编制日期
5. 点击【确认生成】按钮
6. 系统自动生成报告，可在线预览或下载保存
**字段说明：**
| 字段 | 说明 | 必填 |
|------|------|------|
| 报告标题 | 追溯报告的名称 | 是 |
| 追溯类型 | 正向追溯/逆向追溯 | 是 |
| 报告格式 | PDF/Excel/Word | 是 |
| 报告模板 | 简洁版/标准版/详细版 | 是 |
| 追溯原因 | 本次追溯的原因说明 | 是 |
| 编制人 | 编制报告的人员 | 是 |
| 编制日期 | 编制报告的日期 | 是 |
**【提示】** 建议使用标准版或详细版报告模板，以包含完整的追溯数据和细节信息。
### 6.2 报告内容结构
追溯报告应包含以下内容结构：
| 章节 | 内容 |
|------|------|
| 报告封面 | 报告标题、追溯类型、追溯对象、编制信息 |
| 追溯概述 | 追溯原因、追溯范围、追溯时间 |
| 追溯数据 | 追溯链路图、批次流转记录 |
| 详细数据 | 工序作业、检验记录、不良品记录等详细信息 |
| 分析结论 | 问题原因分析、责任判定 |
| 处理建议 | 针对本次追溯结果的处理建议 |
| 附件 | 原始数据截图、相关单据等 |
## 7. 追溯数据维护
### 7.1 数据完整性要求
**【重要】** 为确保追溯数据的完整性和可靠性，必须保证以下数据完整录入：
- 所有来料必须经过 IQC 检验并记录
- 所有物料必须有明确的批次标识
- 所有工序必须有报工记录
- 所有不良品必须登记并跟踪处理结果
- 所有检验记录必须关联批次号和工单号
### 7.2 数据追溯规则
| 规则 | 说明 |
|------|------|
| 批次唯一性 | 同一批次号的物料或产品在整个系统中唯一 |
| 关联完整性 | 批次、工单、检验单之间必须建立关联关系 |
| 时间连续性 | 批次流转的各节点时间必须符合逻辑顺序 |
| 数量一致性 | 领料数量、加工数量、入库数量应保持一致 |
**【注意】** 如果追溯数据存在断点或异常，系统会标记为"追溯异常"，需要人工核实和补充。
## 8. 常见问题与处理
### 8.1 追溯异常处理
| 问题现象 | 可能原因 | 处理方法 |
|---------|---------|---------|
| 追溯链路中断 | 批次信息未录入 | 联系仓库补录入库批次 |
| 数量不匹配 | 报工数量与实际不符 | 联系车间核实报工数据 |
| 时间倒置 | 工序记录时间错误 | 联系相关人员修正时间 |
| 批次缺失 | 物料未进行批次管理 | 建议启用批次管理 |
**【重要】** 发现追溯异常后，应及时查明原因并修正数据，以确保追溯系统的可靠性。
### 8.2 追溯效率优化
为提升追溯查询效率，建议遵循以下原则：
- 定期清理过期数据，保持系统性能
- 规范批次号命名规则，便于识别和查询
- 及时完成报工和检验记录，避免数据延迟
- 建立追溯数据审核机制，确保数据质量

42
env.example Normal file
View File

@@ -0,0 +1,42 @@
# VitePress Docker Configuration
# Copy this file to .env and configure your settings
# ==============================================================================
# Port Configuration
# ==============================================================================
# VitePress documentation server port (external:internal)
VITEPRESS_PORT=3000
# API server port for PDF export (external:internal)
API_PORT=3001
# ==============================================================================
# Directory Configuration
# ==============================================================================
# Path to your VitePress documentation directory
# This directory should contain:
# - index.md (home page)
# - .vitepress/ (configuration)
# - guide/, getting-started/, etc. (documentation folders)
#
# Example: ./docs or absolute path like /home/user/docs
DOCS_DIR=./docs
# ==============================================================================
# PDF Export Configuration
# ==============================================================================
# PDF output will be saved to: ${DOCS_DIR}/dist-pdf/
# ==============================================================================
# Advanced Configuration
# ==============================================================================
# Node environment
NODE_ENV=production
# Puppeteer configuration (for PDF export)
PUPPETEER_SKIP_CHROMIUM_DOWNLOAD=true
PUPPETEER_EXECUTABLE_PATH=/usr/bin/chromium

4901
package-lock.json generated Normal file
View File

File diff suppressed because it is too large Load Diff

15
package.json Normal file
View File

@@ -0,0 +1,15 @@
{
"name": "docs-vitepress",
"version": "1.0.0",
"description": "vitepress在线文档",
"scripts": {
"docs:dev": "vitepress dev docs",
"docs:build": "vitepress build docs",
"docs:preview": "vitepress preview docs",
"export-pdf": "press-export-pdf export docs"
},
"devDependencies": {
"vitepress": "latest",
"vitepress-export-pdf": "^1.0.0"
}
}