Quality Documentation Manager

Note: Bundled scripts ship as Markdown reference (.md) — copy the code out of the .md file to run it.

Quality 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.

Table of Contents

• Document Control Workflow
• Document Numbering System
• Approval and Review Process
• Change Control Process
• 21 CFR Part 11 Compliance
• Reference Documentation
• Tools

Document Control Workflow

Implement document control from creation through obsolescence:

1. Assign document number per numbering procedure
2. Create document using controlled template
3. Route for review to required reviewers
4. Address review comments and document responses
5. Obtain required approval signatures
6. Assign effective date and distribute
7. Update Document Master List
8. Validation: Document accessible at point of use; obsolete versions removed

Document Lifecycle Stages

Document Types and Prefixes

Required Reviewers by Document Type

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

Category Codes

Numbering Workflow

1. Author requests document number from Document Control
2. Document Control verifies category assignment
3. Document Control assigns next available sequence number
4. Number recorded in Document Master List
5. Author creates document using assigned number
6. Validation: Number format matches standard; no duplicates in Master List

Revision Designation

See references/document-control-procedures.md for complete numbering guidance.

Approval and Review Process

Obtain required reviews and approvals before document release.

Review Workflow

1. Author completes document draft
2. Author submits for review via routing form or DMS
3. Reviewers assigned based on document type
4. Reviewers provide comments within review period (5-10 business days)
5. Author addresses comments and documents responses
6. Author resubmits revised document
7. Approvers sign and date
8. Validation: All required reviewers completed; all comments addressed with documented disposition

Comment Disposition

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

Signature Requirements

Change Control Process

Manage document changes systematically through review and approval.

Change Control Workflow

1. Identify need for document change
2. Complete Change Request Form with justification
3. Document Control assigns change number and logs request
4. Route to reviewers for impact assessment
5. Obtain approvals based on change classification
6. Author implements approved changes
7. Update revision number and change history
8. Validation: Changes match approved scope; change history complete

Change Classification

Impact Assessment Checklist

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 |

21 CFR Part 11 Compliance

Implement electronic record and signature controls for FDA compliance.

Part 11 Scope

Electronic Record Controls

1. Validate system for accuracy and reliability
2. Implement secure audit trail for all changes
3. Restrict system access to authorized individuals
4. Generate accurate copies in human-readable format
5. Protect records throughout retention period
6. Validation: Audit trail captures who, what, when for all changes

Audit Trail Requirements

Electronic Signature Requirements

Signature Manifestation

Every electronic signature must display:

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 references/21cfr11-compliance-guide.md for detailed compliance requirements.

Reference Documentation

Document Control Procedures

references/document-control-procedures.md contains:

• 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

21 CFR Part 11 Compliance Guide

references/21cfr11-compliance-guide.md contains:

• 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

Tools

Document Validator

# Validate document metadata
python scripts/document_validator.py --doc document.json

# Interactive validation mode
python scripts/document_validator.py --interactive

# JSON output for integration
python scripts/document_validator.py --doc document.json --output 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)

Sample Document Input

{
  "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

Periodic Review Schedule

Regulatory Requirements

ISO 13485:2016 Clause 4.2

FDA 21 CFR 820

Common Audit Findings

Creator: Ra Qm Team License: MIT Source Repo: neekware/dojo-skills Source Bucket: ra-qm-team Original Path: ra-qm-team/quality-documentation-manager