quality-documentation-manager
Compare original and translation side by side
🇺🇸
Original
English🇨🇳
Translation
ChineseQuality Documentation Manager
质量文档管理器
Document control system design and management for ISO 13485-compliant quality management systems, including numbering conventions, approval workflows, change control, and electronic record compliance.
符合ISO 13485标准的质量管理体系的文档控制系统设计与管理，包括编号规则、审批工作流、变更控制以及电子记录合规性。
Table of Contents
目录
Document Control Workflow
文档控制工作流
Implement document control from creation through obsolescence:
- Assign document number per numbering procedure
- Create document using controlled template
- Route for review to required reviewers
- Address review comments and document responses
- Obtain required approval signatures
- Assign effective date and distribute
- Update Document Master List
- Validation: Document accessible at point of use; obsolete versions removed
实现从创建到淘汰的全流程文档控制：
- 根据编号流程分配文档编号
- 使用受控模板创建文档
- 发送给指定审核人员进行审核
- 处理审核意见并记录回复
- 获取所需的审批签名
- 分配生效日期并发布
- 更新文档主清单
- 验证： 文档在使用点可访问；已淘汰版本已移除
Document Lifecycle Stages
文档生命周期阶段
| Stage | Definition | Actions Required |
|---|---|---|
| Draft | Under creation or revision | Author editing, not for use |
| Review | Circulated for review | Reviewers provide feedback |
| Approved | All signatures obtained | Ready for training/distribution |
| Effective | Training complete, released | Available for use |
| Superseded | Replaced by newer revision | Remove from active use |
| Obsolete | No longer applicable | Archive per retention schedule |
| 阶段 | 定义 | 所需操作 |
|---|---|---|
| 草稿 | 正在创建或修订中 | 作者编辑，不可使用 |
| 审核 | 分发进行审核 | 审核人员提供反馈 |
| 已批准 | 已获取所有签名 | 准备培训/分发 |
| 已生效 | 培训完成，已发布 | 可使用 |
| 已取代 | 被新版本替代 | 从活跃使用中移除 |
| 已淘汰 | 不再适用 | 根据保留计划归档 |
Document Types and Prefixes
文档类型与前缀
| Prefix | Document Type | Typical Content |
|---|---|---|
| QM | Quality Manual | QMS overview, scope, policy |
| SOP | Standard Operating Procedure | Process-level procedures |
| WI | Work Instruction | Task-level step-by-step |
| TF | Template/Form | Controlled forms |
| SPEC | Specification | Product/process specs |
| PLN | Plan | Quality/project plans |
| 前缀 | 文档类型 | 典型内容 |
|---|---|---|
| QM | 质量手册 | QMS概述、范围、政策 |
| SOP | 标准操作流程 | 流程级程序 |
| WI | 作业指导书 | 任务级分步说明 |
| TF | 模板/表单 | 受控表单 |
| SPEC | 规范 | 产品/流程规范 |
| PLN | 计划 | 质量/项目计划 |
Required Reviewers by Document Type
按文档类型划分的指定审核人员
| Document Type | Required Reviewers | Required Approvers |
|---|---|---|
| SOP | Process Owner, QA | QA Manager, Process Owner |
| WI | Area Supervisor, QA | Area Manager |
| SPEC | Engineering, QA | Engineering Manager, QA |
| TF | Process Owner | QA |
| Design Documents | Design Team, QA | Design Control Authority |
| 文档类型 | 指定审核人员 | 指定审批人员 |
|---|---|---|
| SOP | 流程负责人、QA | QA经理、流程负责人 |
| WI | 区域主管、QA | 区域经理 |
| SPEC | 工程部、QA | 工程经理、QA |
| TF | 流程负责人 | QA |
| 设计文档 | 设计团队、QA | 设计控制负责人 |
Document Numbering System
文档编号系统
Assign consistent document numbers for identification and retrieval.
分配一致的文档编号以用于识别和检索。
Numbering Format
编号格式
Standard format:
PREFIX-CATEGORY-SEQUENCE[-REVISION]Example: SOP-02-001-A
SOP = Document type (Standard Operating Procedure)
02 = Category code (Document Control)
001 = Sequential number
A = Revision indicator标准格式：
PREFIX-CATEGORY-SEQUENCE[-REVISION]示例：SOP-02-001-A
SOP = 文档类型（标准操作流程）
02 = 类别代码（文档控制）
001 = 序列号
A = 修订标识Category Codes
类别代码
| Code | Functional Area | Description |
|---|---|---|
| 01 | Quality Management | QMS procedures, management review |
| 02 | Document Control | This area |
| 03 | Human Resources | Training, competency |
| 04 | Design & Development | Design control processes |
| 05 | Purchasing | Supplier management |
| 06 | Production | Manufacturing procedures |
| 07 | Quality Control | Inspection, testing |
| 08 | CAPA | Corrective/preventive actions |
| 09 | Risk Management | ISO 14971 processes |
| 10 | Regulatory Affairs | Submissions, compliance |
| 代码 | 职能领域 | 描述 |
|---|---|---|
| 01 | 质量管理 | QMS程序、管理评审 |
| 02 | 文档控制 | 本领域 |
| 03 | 人力资源 | 培训、能力评估 |
| 04 | 设计与开发 | 设计控制流程 |
| 05 | 采购 | 供应商管理 |
| 06 | 生产 | 制造流程 |
| 07 | 质量控制 | 检验、测试 |
| 08 | CAPA | 纠正/预防措施 |
| 09 | 风险管理 | ISO 14971流程 |
| 10 | 法规事务 | 申报、合规性 |
Numbering Workflow
编号工作流
- Author requests document number from Document Control
- Document Control verifies category assignment
- Document Control assigns next available sequence number
- Number recorded in Document Master List
- Author creates document using assigned number
- Validation: Number format matches standard; no duplicates in Master List
- 作者向文档控制部门申请文档编号
- 文档控制部门验证类别分配
- 文档控制部门分配下一个可用的序列号
- 编号记录在文档主清单中
- 作者使用分配的编号创建文档
- 验证： 编号格式符合标准；主清单中无重复
Revision Designation
修订标识
| Change Type | Revision Increment | Example |
|---|---|---|
| Major revision | Increment number | Rev 01 → Rev 02 |
| Minor revision | Increment sub-revision | Rev 01 → Rev 01.1 |
| Administrative | No change or letter suffix | Rev 01 → Rev 01a |
See for complete numbering guidance.
references/document-control-procedures.md| 变更类型 | 修订增量 | 示例 |
|---|---|---|
| 重大修订 | 递增数字 | 修订01 → 修订02 |
| 次要修订 | 递增子修订号 | 修订01 → 修订01.1 |
| 行政修订 | 无变更或字母后缀 | 修订01 → 修订01a |
完整编号指南请参阅。
references/document-control-procedures.mdApproval and Review Process
审批与审核流程
Obtain required reviews and approvals before document release.
在文档发布前获取指定的审核和审批。
Review Workflow
审核工作流
- Author completes document draft
- Author submits for review via routing form or DMS
- Reviewers assigned based on document type
- Reviewers provide comments within review period (5-10 business days)
- Author addresses comments and documents responses
- Author resubmits revised document
- Approvers sign and date
- Validation: All required reviewers completed; all comments addressed with documented disposition
- 作者完成文档草稿
- 作者通过路由表单或DMS提交审核
- 根据文档类型分配审核人员
- 审核人员在审核周期（5-10个工作日）内提供意见
- 作者处理意见并记录回复
- 作者重新提交修订后的文档
- 审批人员签名并标注日期
- 验证： 所有指定审核人员已完成审核；所有意见均已处理并记录处置结果
Comment Disposition
意见处置
| Disposition | Action Required |
|---|---|
| Accept | Incorporate comment as written |
| Accept with modification | Incorporate with changes, document rationale |
| Reject | Do not incorporate, document justification |
| Defer | Address in future revision, document reason |
| 处置方式 | 所需操作 |
|---|---|
| 接受 | 按原文采纳意见 |
| 接受并修改 | 采纳并修改，记录理由 |
| 拒绝 | 不采纳，记录正当理由 |
| 推迟 | 在未来修订中处理，记录原因 |
Approval Matrix
审批矩阵
Document Level 1 (Policy/QM): CEO or delegate + QA Manager
Document Level 2 (SOP): Department Manager + QA Manager
Document Level 3 (WI/TF): Area Supervisor + QA Representative文档级别1（政策/质量手册）：CEO或授权代表 + QA经理
文档级别2（SOP）：部门经理 + QA经理
文档级别3（作业指导书/表单）：区域主管 + QA代表Signature Requirements
签名要求
| Element | Requirement |
|---|---|
| Name | Printed name of signer |
| Signature | Handwritten or electronic signature |
| Date | Date signature applied |
| Role | Function/role of signer |
| 要素 | 要求 |
|---|---|
| 姓名 | 签名人的打印姓名 |
| 签名 | 手写或电子签名 |
| 日期 | 签名的日期 |
| 角色 | 签名人的职能/角色 |
Change Control Process
变更控制流程
Manage document changes systematically through review and approval.
通过审核和审批系统地管理文档变更。
Change Control Workflow
变更控制工作流
- Identify need for document change
- Complete Change Request Form with justification
- Document Control assigns change number and logs request
- Route to reviewers for impact assessment
- Obtain approvals based on change classification
- Author implements approved changes
- Update revision number and change history
- Validation: Changes match approved scope; change history complete
- 识别文档变更需求
- 填写变更请求表并说明理由
- 文档控制部门分配变更编号并记录请求
- 发送给审核人员进行影响评估
- 根据变更分类获取审批
- 作者实施已批准的变更
- 更新修订号和变更历史
- 验证： 变更符合已批准的范围；变更历史完整
Change Classification
变更分类
| Class | Definition | Approval Level | Examples |
|---|---|---|---|
| Administrative | No content impact | Document Control | Typos, formatting |
| Minor | Limited content change | Process Owner + QA | Clarifications |
| Major | Significant content change | Full review cycle | New requirements |
| Emergency | Urgent safety/compliance | Expedited + retrospective | Safety issues |
| 类别 | 定义 | 审批级别 | 示例 |
|---|---|---|---|
| 行政类 | 无内容影响 | 文档控制部门 | 打字错误、格式调整 |
| 次要类 | 有限的内容变更 | 流程负责人 + QA | 澄清说明 |
| 重大类 | 重大内容变更 | 完整审核周期 | 新要求 |
| 紧急类 | 紧急安全/合规需求 | 快速审批 + 追溯审核 | 安全问题 |
Impact Assessment Checklist
影响评估清单
| Impact Area | Assessment Questions |
|---|---|
| Training | Does change require retraining? |
| Equipment | Does change affect equipment or systems? |
| Validation | Does change require revalidation? |
| Regulatory | Does change affect regulatory filings? |
| Other Documents | Which related documents need updating? |
| Records | What records are affected? |
| 影响领域 | 评估问题 |
|---|---|
| 培训 | 变更是否需要重新培训？ |
| 设备 | 变更是否影响设备或系统？ |
| 验证 | 变更是否需要重新验证？ |
| 法规 | 变更是否影响法规申报？ |
| 其他文档 | 哪些相关文档需要更新？ |
| 记录 | 哪些记录会受到影响？ |
Change History Documentation
变更历史文档
Each document must include change history:
| Revision | Date | Description | Author | Approver |
|----------|------|-------------|--------|----------|
| 01 | 2023-01-15 | Initial release | J. Smith | M. Jones |
| 02 | 2024-03-01 | Updated workflow | J. Smith | M. Jones |每个文档必须包含变更历史：
| 修订版本 | 日期 | 描述 | 作者 | 审批人 |
|----------|------|-------------|--------|----------|
| 01 | 2023-01-15 | 首次发布 | J. Smith | M. Jones |
| 02 | 2024-03-01 | 更新工作流 | J. Smith | M. Jones |21 CFR Part 11 Compliance
21 CFR Part 11合规性
Implement electronic record and signature controls for FDA compliance.
实施电子记录和签名控制以符合FDA要求。
Part 11 Scope
Part 11适用范围
| Applies To | Does Not Apply To |
|---|---|
| Records required by FDA regulations | Paper records |
| Records submitted to FDA | Internal non-regulated documents |
| Electronic signatures on required records | General email communication |
| 适用对象 | 不适用对象 |
|---|---|
| FDA法规要求的记录 | 纸质记录 |
| 提交给FDA的记录 | 内部非法规文档 |
| 要求记录上的电子签名 | 普通电子邮件通信 |
Electronic Record Controls
电子记录控制
- Validate system for accuracy and reliability
- Implement secure audit trail for all changes
- Restrict system access to authorized individuals
- Generate accurate copies in human-readable format
- Protect records throughout retention period
- Validation: Audit trail captures who, what, when for all changes
- 验证系统的准确性和可靠性
- 为所有变更实施安全审计追踪
- 限制系统访问权限至授权人员
- 生成人类可读格式的准确副本
- 在保留期内保护记录
- 验证： 审计追踪捕获所有变更的执行人、内容和时间
Audit Trail Requirements
审计追踪要求
| Requirement | Implementation |
|---|---|
| Secure | Cannot be modified by users |
| Computer-generated | System creates automatically |
| Time-stamped | Date and time of each action |
| Original values | Previous values retained |
| User identity | Who made each change |
| 要求 | 实施方式 |
|---|---|
| 安全 | 用户无法修改 |
| 计算机生成 | 系统自动创建 |
| 带时间戳 | 每个操作的日期和时间 |
| 保留原始值 | 保留之前的值 |
| 用户身份 | 记录每个变更的执行人 |
Electronic Signature Requirements
电子签名要求
| Requirement | Implementation |
|---|---|
| Unique to individual | Not shared between persons |
| At least 2 components | User ID + password minimum |
| Signature manifestation | Name, date/time, meaning displayed |
| Linked to record | Cannot be excised or copied |
| 要求 | 实施方式 |
|---|---|
| 个人唯一 | 不得在人员间共享 |
| 至少2个组件 | 至少用户ID + 密码 |
| 签名显示 | 显示姓名、日期/时间、签名含义 |
| 与记录关联 | 不得被删除或复制 |
Signature Manifestation
签名显示
Every electronic signature must display:
| Element | Example |
|---|---|
| Printed name | John Smith |
| Date and time | 2024-03-15 14:32:05 EST |
| Meaning | Approved for Release |
每个电子签名必须显示：
| 要素 | 示例 |
|---|---|
| 打印姓名 | John Smith |
| 日期和时间 | 2024-03-15 14:32:05 EST |
| 含义 | 批准发布 |
System Controls Checklist
系统控制清单
Access Controls:
- Unique user ID for each person
- Password complexity enforced
- Account lockout after failed attempts
- Session timeout after inactivity
Audit Trail:
- All record creation logged
- All modifications logged with old/new values
- User identity captured
- Date/time stamp on all entries
Security:
- Role-based access control
- Encryption for data at rest and in transit
- Regular backup and tested recovery
See for detailed compliance requirements.
references/21cfr11-compliance-guide.md访问控制：
- 为每个人分配唯一用户ID
- 强制要求密码复杂度
- 多次尝试失败后锁定账户
- 闲置后会话超时
审计追踪：
- 记录所有记录创建操作
- 记录所有修改操作及新旧值
- 捕获用户身份
- 所有条目带日期/时间戳
安全：
- 基于角色的访问控制
- 静态和传输数据加密
- 定期备份并测试恢复
详细合规要求请参阅。
references/21cfr11-compliance-guide.mdReference Documentation
参考文档
Document Control Procedures
文档控制流程
references/document-control-procedures.md- Document numbering system and format
- Document lifecycle stages and transitions
- Review and approval workflow details
- Change control process with classification criteria
- Distribution and access control methods
- Record retention periods and disposal procedures
- Document Master List requirements
references/document-control-procedures.md- 文档编号系统和格式
- 文档生命周期阶段与转换
- 审核和审批工作流详情
- 带分类标准的变更控制流程
- 分发和访问控制方法
- 记录保留期和处置流程
- 文档主清单要求
21 CFR Part 11 Compliance Guide
21 CFR Part 11合规指南
references/21cfr11-compliance-guide.md- Part 11 scope and applicability
- Electronic record requirements (§11.10)
- Electronic signature requirements (§11.50, 11.100, 11.200)
- System control specifications
- Validation approach and documentation
- Compliance checklist and gap assessment template
- Common FDA deficiencies and prevention
references/21cfr11-compliance-guide.md- Part 11的范围和适用性
- 电子记录要求（§11.10）
- 电子签名要求（§11.50, 11.100, 11.200）
- 系统控制规范
- 验证方法和文档
- 合规清单和差距评估模板
- FDA常见缺陷及预防措施
Tools
工具
Document Validator
文档验证器
bash
undefinedbash
undefinedValidate document metadata
Validate document metadata
python scripts/document_validator.py --doc document.json
python scripts/document_validator.py --doc document.json
Interactive validation mode
Interactive validation mode
python scripts/document_validator.py --interactive
python scripts/document_validator.py --interactive
JSON output for integration
JSON output for integration
python scripts/document_validator.py --doc document.json --output json
python scripts/document_validator.py --doc document.json --output json
Generate sample document JSON
Generate sample document JSON
python scripts/document_validator.py --sample > sample_doc.json
Validates:
- Document numbering convention compliance
- Title and status requirements
- Date validation (effective, review due)
- Approval requirements by document type
- Change history completeness
- 21 CFR Part 11 controls (audit trail, signatures)python scripts/document_validator.py --sample > sample_doc.json
验证内容：
- 文档编号规则合规性
- 标题和状态要求
- 日期验证（生效日期、审核到期日）
- 按文档类型划分的审批要求
- 变更历史完整性
- 21 CFR Part 11控制（审计追踪、签名）Sample Document Input
示例文档输入
json
{
"number": "SOP-02-001",
"title": "Document Control Procedure",
"doc_type": "SOP",
"revision": "03",
"status": "Effective",
"effective_date": "2024-01-15",
"review_date": "2025-01-15",
"author": "J. Smith",
"approver": "M. Jones",
"change_history": [
{"revision": "01", "date": "2022-01-01", "description": "Initial release"},
{"revision": "02", "date": "2023-01-15", "description": "Updated workflow"},
{"revision": "03", "date": "2024-01-15", "description": "Added e-signature requirements"}
],
"has_audit_trail": true,
"has_electronic_signature": true,
"signature_components": 2
}json
{
"number": "SOP-02-001",
"title": "Document Control Procedure",
"doc_type": "SOP",
"revision": "03",
"status": "Effective",
"effective_date": "2024-01-15",
"review_date": "2025-01-15",
"author": "J. Smith",
"approver": "M. Jones",
"change_history": [
{"revision": "01", "date": "2022-01-01", "description": "Initial release"},
{"revision": "02", "date": "2023-01-15", "description": "Updated workflow"},
{"revision": "03", "date": "2024-01-15", "description": "Added e-signature requirements"}
],
"has_audit_trail": true,
"has_electronic_signature": true,
"signature_components": 2
}Document Control Metrics
文档控制指标
Track document control system performance.
跟踪文档控制系统的性能。
Key Performance Indicators
关键绩效指标
| Metric | Target | Calculation |
|---|---|---|
| Document cycle time | <30 days | Average days from draft to effective |
| Review completion rate | >95% | Reviews completed on time / Total reviews |
| Change request backlog | <10 | Open change requests at month end |
| Overdue review rate | <5% | Documents past review date / Total effective |
| Audit finding rate | <2 per audit | Document control findings per internal audit |
| 指标 | 目标 | 计算方式 |
|---|---|---|
| 文档周期时间 | <30天 | 从草稿到生效的平均天数 |
| 审核完成率 | >95% | 按时完成的审核数 / 总审核数 |
| 变更请求积压 | <10 | 月末未处理的变更请求数 |
| 逾期审核率 | <5% | 超过审核日期的文档数 / 总生效文档数 |
| 审计发现率 | <2个/审计 | 每次内部审计中的文档控制发现数 |
Periodic Review Schedule
定期审核计划
| Document Type | Review Frequency |
|---|---|
| Policy | Every 3 years |
| SOP | Every 2 years |
| WI | Every 2 years |
| Specifications | As needed or with product changes |
| Forms/Templates | Every 3 years |
| 文档类型 | 审核频率 |
|---|---|
| 政策 | 每3年一次 |
| SOP | 每2年一次 |
| 作业指导书 | 每2年一次 |
| 规范 | 按需或随产品变更 |
| 表单/模板 | 每3年一次 |
Regulatory Requirements
法规要求
ISO 13485:2016 Clause 4.2
ISO 13485:2016 第4.2条
| Sub-clause | Requirement |
|---|---|
| 4.2.1 | Quality management system documentation |
| 4.2.2 | Quality manual |
| 4.2.3 | Medical device file (technical documentation) |
| 4.2.4 | Control of documents |
| 4.2.5 | Control of records |
| 子条款 | 要求 |
|---|---|
| 4.2.1 | 质量管理体系文档 |
| 4.2.2 | 质量手册 |
| 4.2.3 | 医疗器械文件（技术文档） |
| 4.2.4 | 文档控制 |
| 4.2.5 | 记录控制 |
FDA 21 CFR 820
FDA 21 CFR 820
| Section | Requirement |
|---|---|
| 820.40 | Document controls |
| 820.180 | General record requirements |
| 820.181 | Device master record |
| 820.184 | Device history record |
| 820.186 | Quality system record |
| 章节 | 要求 |
|---|---|
| 820.40 | 文档控制 |
| 820.180 | 通用记录要求 |
| 820.181 | 设备主记录 |
| 820.184 | 设备历史记录 |
| 820.186 | 质量体系记录 |
Common Audit Findings
常见审计发现
| Finding | Prevention |
|---|---|
| Obsolete documents in use | Implement distribution control |
| Missing approval signatures | Enforce workflow before release |
| Incomplete change history | Require history update with each revision |
| No periodic review schedule | Establish and enforce review calendar |
| Inadequate audit trail | Validate DMS for Part 11 compliance |
| 发现 | 预防措施 |
|---|---|
| 使用已淘汰的文档 | 实施分发控制 |
| 缺少审批签名 | 发布前强制执行工作流 |
| 变更历史不完整 | 要求每次修订时更新历史 |
| 无定期审核计划 | 建立并执行审核日历 |
| 审计追踪不足 | 验证DMS符合Part 11合规性 |