Skip to content

README

Jump to bottom
github-actions[bot] edited this page Apr 1, 2026 · 1 revision

LIMIS 知识库（Wiki）首页

欢迎来到 LIMIS（实验室信息管理系统） 官方知识库。本文档集面向最终用户、业务管理员、运维人员与研发人员，采用分层目录与交叉引用，便于按角色、场景与问题类型快速定位。

范围说明：本仓库 Wiki 以当前代码库行为与约定为准；若与现场定制部署不一致，请以环境内的《部署说明》或变更单为准，并建议将差异回写至本 Wiki（见 维护约定）。

文档统计与完整目录

共计正文文档 44 篇（不含本 README.md 首页与 Wiki 门户页 Home.md），按 10 个一级分类组织如下。

分类 目录 篇数 内容侧重
入门与概念 01-getting-started/ 5 系统概览、术语、环境、首次登录、界面导航
架构 02-architecture/ 5 前后端架构、领域模型、集成边界
研发 03-development/ 7 本地开发、规范、测试、Git、调试、贡献、GitHub Wiki 同步
部署 04-deployment/ 5 部署形态、配置、代理、备份恢复
API 与对接 05-api-and-integration/ 4 JWT、REST 约定、错误码、前端请求信封
用户功能指南 06-user-guide/ 6 委托/检测/报告/质量/资源/系统管理界面
常见问题（FAQ） 07-faq/ 3 登录与会话、业务流程、运维
安全与合规 08-security-compliance/ 4 授权模型、审计、数据安全、标准元数据爬取
运维专题 09-operations-maintenance/ 4 巡检清单、日志监控、数据库、事件响应
项目状态摘要 10-project-status-snapshot.md 1 与主仓库 PROJECT_STATUS.md 对齐的速览

合计：5 + 5 + 7 + 5 + 4 + 6 + 3 + 4 + 4 + 1 = 44。

GitHub Wiki 门户页：根目录 Home.md 为 Wiki 默认首页；完整索引仍以本 README.md 为准。

CI 同步：向 main 推送且变更 wiki/** 时，由主仓库工作流 wiki-sync.yml 将本目录同步至 https://github.com/Uuclear/limis.wiki.git，详见 GitHub Wiki 同步说明。

完整文档列表（含相对链接）

01-getting-started/（5）

  1. LIMIS 系统概览
  2. 术语与缩写表
  3. 运行环境与浏览器要求
  4. 首次登录与个人资料
  5. 界面导航与菜单地图

02-architecture/（5）

  1. 系统架构总览
  2. 后端技术栈（Django / DRF）
  3. 前端技术栈（Vue）
  4. 核心业务对象与数据域
  5. 外部系统集成点

03-development/（7）

  1. 本地开发环境搭建
  2. 编码规范与工程约定
  3. 测试策略与执行
  4. Git 分支与协作流程
  5. 调试手册（前后端）
  6. 贡献指南
  7. GitHub Wiki 同步（CI → .wiki.git）

04-deployment/（5）

  1. 部署总览
  2. 运行时与进程模型
  3. 配置项与密钥管理
  4. 反向代理与 TLS
  5. 备份与恢复

05-api-and-integration/（4）

  1. 认证与 JWT（含会话版本）
  2. REST API 约定
  3. 错误响应与业务码
  4. 前端请求信封与字段兼容

06-user-guide/（6）

  1. 工程项目与委托管理
  2. 样品、检测任务与结果
  3. 报告编制与签发流程
  4. 质量体系相关模块
  5. 仪器设备、耗材与环境监控
  6. 系统管理（用户、角色、日志）

07-faq/（3）

  1. 登录、权限与会话 FAQ
  2. 业务流程 FAQ
  3. 运维 FAQ

08-security-compliance/（4）

  1. 授权模型与模块权限
  2. 审计与操作日志
  3. 数据安全与敏感信息
  4. 标准规范元数据与工标网爬取说明

09-operations-maintenance/（4）

  1. 例行巡检清单
  2. 日志与监控
  3. 数据库运维
  4. 事件响应与通报

项目状态（1）

  1. 项目状态摘要（与 PROJECT_STATUS.md 对齐）

与既有 Wiki 章节的对应关系（迁移说明）

仓库中另有一套按主题渐进补充的文档（如 01-system-overview/、02-user-guides/、03-admin-guides/、05-api-docs/）。两套目录互为补充：本页列出的 42 篇 为结构化主干；阅读时可对照下表跳转，避免内容重复维护时产生冲突。

新结构（本索引） 既有文档（参考）
01-limis-overview 产品定位
02-architecture 总览 架构与技术栈
06 用户指南 · 委托/项目 项目管理用户指南、委托管理
07-faq 登录权限 权限排错、会话安全
05-api 认证 认证与 Token API
05-api 信封 API 约定与信封

按角色阅读路径

角色 建议路径 说明
新入职检测/报告人员 入门 1～5 → 用户指南 26～29 → 业务流程 FAQ 先建立全局概念，再跟业务主链路，遇到卡点查 FAQ。
质量负责人 / 体系管理员 质量体系模块 → 授权模型 → 审计日志 → 标准爬取 覆盖标准、模板、内审与管理评审相关能力及合规留痕。
系统 / 实验室管理员 系统管理界面 → 登录权限 FAQ → 部署与配置 17～21 → 巡检清单 用户角色、日常巡检与变更窗口。
运维 / 基础设施 部署总览 → 运行时 → 日志与监控 → 运维 FAQ → 事件响应 上线、排障、容量与应急。
后端研发 架构 6～10 → 认证 JWT → REST 约定 → 本地开发 API 与领域扩展的入口。
前端研发 前端栈 → 前端请求信封 → 界面导航 → 调试手册 路由权限、接口信封与字段兼容。

按场景阅读路径

场景 入口文档 延伸阅读
首次登录后菜单空白或 403 登录权限 FAQ 授权模型、系统管理
委托—样品—检测—报告主链路不熟 工程项目与委托 业务流程 FAQ、样品与检测、报告流程
Token 过期、被踢下线、多端登录 登录权限 FAQ § 会话 认证 JWT
工标网爬取回填字段不全 标准爬取说明 前端信封
生产环境升级与回滚 部署总览 备份恢复、运维 FAQ
接口联调异常、HTTP 200 但业务失败 错误响应与业务码 REST 约定

按问题类型阅读路径

问题类型 优先查阅
账号 / 密码 / 锁定 / 会话失效 登录权限 FAQ → 认证 JWT
角色、模块权限、菜单不可见 授权模型 → 登录权限 FAQ
业务状态、单据流转、谁能改 业务流程 FAQ → 对应 用户指南 章节
性能、宕机、日志、备份 运维 FAQ → 巡检清单 → 日志与监控
合规、审计、留痕 审计与操作日志 → 数据安全

新手 1 小时路径（建议）

目标：能在系统中完成一次「从菜单找到模块 → 理解主业务名词 → 知道遇到问题去哪查」。

时段 动作 文档
0～10 分钟 了解系统边界与模块划分 LIMIS 系统概览、界面导航与菜单地图
10～25 分钟 弄清委托—样品—检测—报告主路径 工程项目与委托、样品、检测任务与结果（可跳读小节）
25～40 分钟 登录、权限、会话常见现象 登录、权限与会话 FAQ（至少读完「会话与 JWT」与「菜单与权限」两节）
40～55 分钟 质量体系与报告相关入口 质量体系相关模块 或 报告编制与签发（二选一深读）
55～60 分钟 收藏首页与 FAQ，建立查找习惯 回到本 README.md，将 业务流程 FAQ 加入书签

若岗位偏管理或运维，可将最后 20 分钟替换为 系统管理界面 + 例行巡检清单 扫读。

管理员日常巡检路径（建议）

面向：系统管理员、运维值班、实验室负责人（兼管系统）。每日 10～15 分钟；发版日或故障后按扩展项执行。

每日（10～15 分钟）

  1. 例行巡检清单 中的「快速项」：应用可用性、错误日志摘要、磁盘与数据库连通性。
  2. 抽查 操作日志 中异常删除或批量导出行为（与 审计 要求一致时）。
  3. 若有用户报「突然全部下线」或「权限变了」，对照 登录权限 FAQ 中的会话与踢出条目。

每周

  • 备份任务成功性确认（见 备份与恢复）。
  • 依赖与安全补丁窗口评估（与研发/运维负责人对齐）。

每月

  • 角色与账号复核（离职转岗、外包账号）。
  • 回顾 运维 FAQ 是否需增补现场特例。

扩展（发版 / 故障后）

维护约定

文档更新频率

文档类型 最低更新频率 触发条件
本 README.md 目录索引 随文档增删改即时 新增/重命名/删除任意正文文档；合并 main 后 CI 同步至 GitHub Wiki
FAQ（07-faq/） 每季度复盘，或每 10 条同类工单 重复咨询 ≥3 次即评估入库
部署与运维（04-deployment/、09-operations-maintenance/） 每次发版或基础设施变更后 配置项、端口、备份策略变化
API 与前端信封（05-api-and-integration/） 每次公共 API 契约变更 认证方式、统一响应结构、字段命名变更
用户指南（06-user-guide/） 每个大版本界面或流程变更后 菜单重组、状态机变更

责任角色（RACI 简述）

活动 负责（R） 审批（A） 咨询（C） 知会（I）
目录结构与交叉链接正确 研发负责人或指定 Wiki 编辑 项目经理或产品负责人 运维与测试代表 全团队
FAQ 条目技术准确性 对应模块开发者 研发负责人 技术支持 用户代表
运维类步骤可执行性 运维负责人 安全/合规接口人（如涉及） 研发 管理层（重大变更）

现场若无明确岗位，可由 项目经理指定单一 Wiki Owner 代行「负责」列职责。

变更记录模板

在文档 底部 或项目变更单中记录；重大变更建议同时在版本控制系统提交信息中引用 Issue/工单号。

## 变更记录

| 日期 | 版本 | 作者 | 摘要 |
|------|------|------|------|
| YYYY-MM-DD | 1.0 | 姓名 | 初版 |
| YYYY-MM-DD | 1.1 | 姓名 | 增补 XXX 章节；修正与 YYY 文档的链接 |

单篇文档内可使用简化版：

> **修订**：2026-04-01，某某：补充 Z 场景说明。

关于 SYSTEM_USER_MANUAL.md

仓库中的 wiki/SYSTEM_USER_MANUAL.md 为 全角色长篇操作手册（与本文档集的 42 篇 并列互补）。需要「单文件通读」全流程时可优先阅读该手册；需要 按角色/场景检索 时使用本 README.md 索引与分类目录。若某处表述冲突，以 当前代码与现场部署说明 为准，并建议更新其中一侧后同步另一侧的交叉链接。

反馈与改进

若发现文档错误或希望补充场景，请通过团队约定的工单渠道或 Merge Request 提交；提交时请注明「受影响章节」「期望行为」与「现场环境差异（若有）」，便于 变更记录模板 追溯。

返回：本页顶部

Clone this wiki locally