Do you have version numbers in documents and design files?

Last updated by Tiago Araújo [SSW] 6 months ago.See history

It is very important to have your Word, PowerPoint, PDFs, and design documents up-to-date. You should also make it easy for anyone to identify which version they are looking at. The most effective way to achieve this is by placing the version number on the right-hand side of the footer.

scrum image version number
Figure: Good example - Version number on the RHS of a design document

See how you increase the version number:

  • Major 1.0 - Rarely change - only with major upgrades. E.g. Complete redesign
  • Minor 1.1 - New features / release (customer facing) E.g. Add/remove a heading or a section
  • Revision 1.11 - Emergency maintenance, spelling fixes

Add major version numbers in internal file names

For internal use, it is also good practice to include the major version number in the name of the files. This helps navigating through the old and the new versions, and makes it easy to roll back any changes and use an older version. For public files you should not include version numbers.

Warning: This should only be changed on major versions and only on internal documents.

codeauditor\file.pdf codeauditor\new\file.pdf codeauditor\file_latest.pdf

Figure: Bad example - Internal file names do not show any version information

codeauditor\filev1.pdf codeauditor\filev2.pdf codeauditor\file_v3.pdf

Figure: Good example - Internal file names show the version information

We open source. Powered by GitHub