Files
Agent-System/docs/user-manual/README.md
T

30 lines
1.7 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
# 系统使用说明书(水木东方 · 医疗器械 AI 协同工作台)
面向终端用户与系统管理员的完整使用说明书,覆盖:从 0 进入系统、登录/注册、管理员配置角色与权限、项目使用、AI 对话、文档工作台、审批全流程、FAQ。全部截图为 dev 环境真实操作采集(含真实 PI Agent 对话)。
## 文件说明
| 路径 | 说明 |
|------|------|
| [manual.md](./manual.md) | 说明书主文档(Markdown 源,SSOT) |
| [images/](./images/) | 全部 UI 截图(PNG,编号对应章节) |
| [dist/系统使用说明书.html](./dist/系统使用说明书.html) | HTML 版(单文件,图片已嵌入,浏览器直接打开) |
| [dist/系统使用说明书.pdf](./dist/系统使用说明书.pdf) | PDF 版(A4) |
| [dist/系统使用说明书.docx](./dist/系统使用说明书.docx) | Word 版 |
| [scripts/capture-screenshots.mjs](./scripts/capture-screenshots.mjs) | 截图采集脚本(Playwright,需 dev 环境运行在 8080) |
| [scripts/build-formats.mjs](./scripts/build-formats.mjs) | 格式生成脚本(pandoc + playwright) |
## 重新生成
```bash
# 重新采集截图(dev 环境需在运行,会创建「说明书演示」前缀的演示数据)
node docs/user-manual/scripts/capture-screenshots.mjs
# 重新生成 HTML / PDF / DOCX
node docs/user-manual/scripts/build-formats.mjs
```
注意:`dist/` 在根 `.gitignore` 中被忽略,本仓库通过 `git add -f` 强制纳入版本管理;本地重新生成后需同样 `git add -f docs/user-manual/dist`。
依赖:pandoc(`brew install pandoc`)、playwright docker 镜像 `mcr.microsoft.com/playwright:v1.63.0-noble`(PDF 打印在容器内执行,主机缺 chromium 系统依赖)。