Control document versions

Document versions (aka revisions, versions, etc…) is very important to control changes benefit us in safety moving forward. We use software built-in Page history feature for document version control. Here are rules and tips

This tutorial sample in this guideline used Confluence. For other tool, you should found the similar ways in tool's help page or support sites.

Rule 1: Use built-in revision/version feature instead of file name

Confluence, Google Docs, Microsoft Office 365 all offer revision document control right in the software nowadays.

❌️ Use file name to express revision/version

✔️ Use built-in feature

Rule 2: Edit to update, Save/Publish with comment/version name

Instead of create a new document (Page) for a new version, do update on the same document. This practice help our space lean (no out-dated page) and our document living (always update)

When document is good enough, do Publish with version comment to brief changes for future reference.

Avoid tracking document version manually (track change in document content) 🔴

image-1622904064583.png

You can view all tracked version, the changes between different versions, and roll back to a previous version if you need to by using Confluence Page History and Page Comparison Views 💪

image-1622904072869.png

Rule 3: Notify change on Slack to keep the team update

Even when you updated document, do drop a Slack message to inform everybody on your changes, with Link to page. Everybody will appreciate your professional.

💪 Use Share button > Copy link to got shortlink to the page.