Cyberstudy
PDF p.390 In progress

Documentation and Version Control

Open PDF at p.390 9 flashcards

Summary

PDF p.390

Version control tracks and manages changes to documents, code, and other important data. It maintains a historical record, ensures only approved changes are implemented, and allows quick reversion to previous versions. This prevents confusion from outdated or inconsistent documents.

In plain words

Supplementary — not from your PDF

Version control tracks changes to documents, code and data, keeping a history, ensuring only approved changes go live, and allowing quick reversion. It prevents confusion from outdated or inconsistent documents. Impact assessment checks how changes affect existing policies, procedures and diagrams, and change plans should include updating and archiving documents and training teams.

Detailed explanation

PDF p.390
  • Version Control
    • Purpose: Track and control changes to documents and data.
    • Benefits: Maintain historical records, ensure approved changes, revert to previous versions.
    • Importance: Prevents confusion from outdated documents.
  • Impact Assessment
    • Purpose: Assess how changes impact existing policies, procedures, and diagrams.
    • Change Management Plans: Include provisions for document updates.
    • Frequency: Update documents with significant changes or modifications.
    • Labeling and Archiving: Clearly label new versions and archive older ones for reference.
    • Training: Major changes may require training for relevant teams.

Important terms

taken from the text above
Change Management Plans
Include provisions for document updates.
Frequency
Update documents with significant changes or modifications.
Labeling and Archiving
Clearly label new versions and archive older ones for reference.
Training
Major changes may require training for relevant teams.

Examples & real-world scenarios

Supplementary — not from your PDF
  • Version control keeping a history of a policy document.
  • Reverting to a previous config version after a bad change.
  • Archiving the old version and labelling the new one.

Scenario

Staff follow an outdated network diagram and misconfigure a device. Version control with clear labelling would have ensured they used the current version.

Common mistakes

Supplementary — not from your PDF
  • Leaving multiple unlabelled document versions in circulation.
  • Not updating documentation after a change.

Practical skills

Supplementary — not from your PDF
  • Explain how version control supports change management.

What I should remember

Key Points PDF p.390
  • Version Control: Track changes, maintain records, ensure approved changes.
  • Impact Assessment: Assess and update documents.
  • Labeling and Archiving: Label new versions, archive old ones.
  • Training: Provide training for major changes.