Version Control


Version control refers to tracking and controlling changes to documents, code, or other important data.

  • used to
    • maintain a historical record of changes
    • ensure only approved changes are implemented
    • quickly revert changes to a previous version as warranted
  • prevents confusion associated with using outdated or inconsistent documents
  • Versioning format
    • can vary by company
    • common format: MAJORversion.MINORversion.PATCHversion
      • e.g., v3.2.4

Example documentation impacted by version control

ItemDescription
Change RequestsChange requests themselves should be reviewed and updated to reflect the details and status of the change, including any modifications or approvals during the change management process.
Policies and ProceduresChanges may impact existing policies and procedures. As a result, these documents need to be reviewed and updated to ensure they align with the new processes, guidelines, or controls introduced through the change.
System or Process DocumentationDocumentation should reflect any changes to systems, applications, or processes. It may involve updating system architecture, diagrams, process flows, standard operating procedures (SOPs), or user manuals to represent the current state and functionality of the changed system.
Configuration Management DocumentationChanges to configuration items, such as servers, networks, or databases, should be tracked and documented within the configuration management system to maintain an accurate record of its configuration.
Training MaterialsChanges often impact employees, and they may require more training. Existing training materials, such as presentations, manuals, or computer-based learning modules, must be reviewed and updated as warranted.
Incident Response and Recovery PlansChanges made to systems or applications may necessitate updates to incident response and recovery plans to ensure they account for the revised configurations, new dependencies, or recovery procedures resulting from the change.