Table of Contents
Report Versioning and Document Control
Every time you save or update a report, a complete version snapshot is preserved. This guide explains how versioning works and how it relates to quality management system requirements for documented information control.
Overview
Quality management systems require organizations to control documented information -- including quality reports, inspection records, CAPA reports, and analysis results. A key aspect of this control is maintaining a history of changes so that previous versions can be retrieved, compared, and traced back to the person who made the change.
This application provides two types of versioning to address these requirements:
Report Instance Versioning (Your Data)
Each time you save changes to a report (SPC analysis, CAPA, FMEA, inspection result, etc.), the system creates a complete, immutable snapshot of the report data. Previous versions are never overwritten or deleted -- they remain accessible for audit review.
Report Template Versioning (System Design)
When the application's PDF report format changes (new summary sections, updated calculations, additional charts), a template version identifier is recorded. This allows you to distinguish reports generated under different template revisions -- even if the underlying data is the same.
How Versioning Works
The versioning system uses a snapshot-forward approach. Each version stores the complete state of the report at that point in time. This means any version can be viewed independently without needing to reconstruct it from a chain of changes.
When You Save a Report for the First Time
The initial save creates two records:
- The report itself (your latest working copy)
- Version 1 -- a complete snapshot of the report data, title, and metadata at the time of creation
- The version records who created it and when
When You Update a Report
Each update creates a new version with the next sequential number:
- A new version snapshot is created with the updated data
- You can optionally describe what changed (e.g., "Added root cause findings" or "Updated measurements from second production run")
- The previous version remains untouched and accessible
Why Complete Snapshots?
Some systems store only the differences between versions (deltas). This application stores the complete report data for each version instead. While this uses slightly more storage, it means that any version can be opened and viewed exactly as it was -- without the risk of reconstruction errors. For quality audit purposes, this approach prioritizes reliability and simplicity over storage savings.
Template Version Tracking
Each PDF report includes a template version identifier in the footer. If the report layout or calculation methodology changes in a software update, the template version changes accordingly. This allows you to identify which template was used to generate a particular report -- useful when a customer or auditor notices a difference between two reports generated at different times.
What Gets Tracked in Each Version
Each version snapshot captures the following information:
| Field | Description |
|---|---|
| Version Number | Sequential identifier (1, 2, 3, ...) unique to each report |
| Report Data | Complete report content as it existed at the time of this version |
| Title | The report title at the time of this version |
| Change Description | Optional user-provided description of what changed (e.g., "Added corrective actions") |
| Changed By | The authenticated user who created this version |
| Timestamp | Exact date and time (UTC) when this version was saved |
| Template Version | The PDF report template version that was active when this version was saved |
ISO 9001:2015 -- Quality Management Systems
ISO 9001:2015 establishes requirements for documented information in quality management systems. The following clauses are relevant to report versioning:
Clause 7.5.2 -- Creating and Updating Documented Information
This clause requires that documented information has appropriate identification and description, including titles, dates, authors, and reference numbers. The versioning system addresses this by:
- Assigning a sequential version number to each report revision
- Recording the date, time, and author of each version
- Preserving the title and content at each version point
Clause 7.5.3 -- Control of Documented Information
This clause requires organizations to address distribution, access, retrieval, storage, preservation, change control, retention, and disposition of documented information. Specifically, subclause 7.5.3.2 states that organizations shall address "changes (e.g., version control)" and "protection against unintended alteration." The versioning system addresses this by:
- Maintaining an immutable history of all versions -- once created, a version cannot be modified or deleted individually
- Ensuring the current (latest) version is always clearly identified
- Allowing previous versions to be retrieved and reviewed at any time
- Recording who made each change and when
Clause 8.5.2 -- Identification and Traceability
This clause requires suitable means to identify outputs and ensure conformity. Report versioning enables traceability from inspection results and analysis reports back to the specific version that was active when a decision was made. If an SPC report was cited in a customer submission, the exact version used can be retrieved even if the report has been updated since.
Clause 10.2 -- Nonconformity and Corrective Action
This clause requires retaining documented information as evidence of nonconformities, actions taken, and results. CAPA reports, nonconformity reports, and root cause analysis reports often evolve through multiple revisions as investigations progress. The versioning system preserves each stage -- from initial problem description through root cause identification to corrective action verification -- providing auditors with a complete documented trail.
IATF 16949 -- Automotive Quality Management
IATF 16949 builds on ISO 9001 with additional automotive industry requirements. Section 7.5.3.2.2 requires a process to prevent unintended use of obsolete documents and to apply suitable identification when obsolete documented information is retained. The versioning system relates to these requirements by:
- Clearly identifying the current (latest) version of any report -- the most recent version is always what users see by default
- Retaining previous versions with clear version numbers and timestamps so they are distinguishable from the current version
- Stamping PDF reports with template version identifiers to distinguish between reports generated under different template revisions, which is relevant for PPAP documentation and customer quality record submissions
ISO 13485 -- Medical Device Quality Management
ISO 13485 imposes heightened requirements for document version history in medical device manufacturing, including change justifications and traceable approval chains. The versioning system relates to these requirements by:
- Maintaining a complete version history with sequential numbering for every report revision
- Recording the authenticated user identity for each version, providing traceability to who made the change
- Supporting optional change descriptions that can serve as change justifications when users provide them
Electronic Records and Audit Trails
Regulations governing electronic quality records require audit trails that capture who changed what, when, and the state of the record before and after the change. The versioning system relates to these requirements by providing:
- A chronological trail of every report revision, each with its own version number and timestamp
- Authenticated user identity recorded for each version (who made the change)
- Complete before-and-after state: since each version stores the full report data, comparing any two versions shows exactly what changed
- Immutable version records that cannot be modified after creation, protecting against unintended or unauthorized alteration
ISO/IEC 17025 -- Laboratory and Calibration Requirements
ISO/IEC 17025 requires version control for measurement reports and calibration certificates. Amendments to reports must be clearly identified. The versioning system relates to these requirements by:
- Preserving the original version of any measurement report or calibration record
- Clearly identifying amendments through sequential version numbering and optional change descriptions
- Stamping template version identifiers into generated PDF reports, allowing laboratories to distinguish between reports generated under different calculation or formatting methodologies
Audit Readiness Scenarios
During a typical quality audit, auditors may ask questions that require version history. Here are common scenarios and how the versioning system helps you respond:
The auditor needs to confirm they are looking at the latest version and that previous versions are accessible but clearly marked as superseded.
The report always displays the latest version by default. Open the version history to show all previous versions with their version numbers and dates. The highest version number is always the current one.
The auditor wants to see the progression from initial problem report through root cause analysis to corrective action.
Open the version history for the CAPA report. Each version shows its timestamp and change description. Select version 1 to view the original report, then compare with later versions to show the investigation progression.
The auditor wants to verify the approval chain for document changes.
Each version records the authenticated user who created it. The version history shows the user name and timestamp for every revision. This provides traceability for who made each change.
A customer notices a difference in report format between two time periods and wants to know if it reflects a process change.
Check the template version in the PDF footer of each report. If the template version differs (e.g., "Template v1.0" vs "Template v2.0"), the difference is due to a report format update, not a process change. The template version manifest documents what changed between template versions.
Frequently Asked Questions
- How many versions are kept?
- All versions are retained. No versions are automatically deleted or pruned. This ensures that the complete history is always available for audits.
- Can I delete a specific version?
- No. Individual versions cannot be deleted. This is by design -- immutability protects the integrity of the audit trail. If you delete the entire report, all versions are removed together.
- Can I restore an older version?
- Yes. Restoring an older version creates a new version (with the next sequential number) containing the data from the selected version. The intermediate versions are preserved -- nothing is overwritten.
- Is the change description required?
- No, it is optional. However, providing a brief description of what changed (e.g., "Added corrective actions" or "Updated measurements") creates a more useful audit trail and is recommended for reports subject to regulatory review.
- Which tools support versioning?
- All tools that produce saved reports support versioning. This includes SPC Quick Check, Attribute Charts, CAPA, Fishbone, 5 Whys RCA, Non-Conformity Reports, FMEA, Inspection Forms, and all other analysis tools. Versioning is applied at the report level, not per tool.
- What is the template version in the PDF footer?
- The template version identifies which PDF report layout was used to generate the document. If the application updates the report format (adding new summary sections, changing chart layouts, or updating calculation displays), the template version is incremented. This helps distinguish between format changes and process changes when comparing reports from different time periods.
Important Note
This guide describes how the versioning features of this application relate to the documented information control requirements found in various quality management standards. This application is a tool that can support your quality management system -- it is not a substitute for your organization's own document control procedures, training, and compliance programs. Your organization is responsible for determining whether and how this tool fits within your overall quality management system. References to specific standards are for informational purposes and describe general requirements; consult the official published standards for the authoritative text.