Tuesday, December 02, 2008

The Importance of Document Versioning

(Written for The Ford Foundation colleagues in Asia region.)

A user in Beijing office has had some bad luck lately. She lost a Word document which mysteriously disappeared all of a sudden and had to painfully restart writing it. We all know how it is - the ideas and passion can hardly be the same as when one just started fresh.

She then almost lost an important email when her desktop froze. Luckily Outlook kept it in her draft folder and she was able to get it back after quite some time of worrying over the seemingly dead machine.

All these can be avoided or loss minimized if we practice personal document versioning - forget about those clumsy doc versioning software applications like HyperOffice, which are for organizations and for team collaboration. (By the way, Blogger's autosave feature is quite nice - it seems to save my draft every minute. This is good thinking and design for users' benefits!)

Document versioning I am talking about here is very simple. We just need to remember the following when we work on a document:
  1. Save the document every 5 or 10 minutes. Do not trust your computers. Do not trust the backup tapes in the server room. Do not rely on your application's auto-save feature. Do not think your IT support people (that's us TAs!) will always be able to recover your documents if they get lost. The only person in the whole world you can depend on is ... yourself! You may say it is not easy to remember that when I am carried away by madly putting my thoughts down. Well, train yourself and make it a habit. Can you afford losing an hour's creative thinking? Probably not even half an hour's, right? To save your precious work, it just takes you a split second to press Ctrl-S with Microsoft Word and many other applications.
  2. Save your documents with a very descriptive name. Think carefully about the name. Make it clear and unique, so that you know immediately what it is as soon as you see the file name without the need of opening it after months or even years. Remember you have or are going to have tens of thousands of documents in your computer or computers. You may know a document very well now but not so in a couple of months time. It will only take you a couple of minutes to think and type a long and descriptive name but it will save you enough time in the future to finish another long document. I am so glad that Windows supports long file names up to 255 characters each. Well... Do not always name your documents that long! ;-)
  3. Save your documents with dates and version numbers. Dates will remind yourself when you started the document. Version numbers will make sure you can roll back to an earlier version, especially when you need to work on the doc for an extended length of time. My personal preference for date format is yyyy-mmdd - 2008-0928. This will ensure my documents is always in the order of date.
  4. Save your documents with different version numbers at a regular interval. This serves two pusposes: 1) You will be able to easily roll back to any older version; 2) You will still have an older version to go back to if the one you currently work on gets either corrupted or lost. Different version numbers also allow you to tell which one you should use if you are working on more than one computer and have to port your documents from one to the other.
  5. Always save your document with a new version number if you resume working on an existing document copied from another computer. It is nightmarish if you work on the same document on two machines, each with some contents that the other one does not have.
An example:

  1. If I were writing this in Microsoft Word, the first thing I should do would be saving it with this name: "The Importance of Doc Versioning (for Ford Foundation users), 2008-0928, v1.00a.doc". It takes me about 30 seconds to plan the name, type it, and edit it.
  2. I would press Ctrl-S to save it every few minutes.
  3. In about 20 or 30 minutes, I would use "Save as..." from the menu to save it to: "The Importance of Doc Versioning (for Ford Foundation users), 2008-0928, v1.00b.doc". Then v1.00c, v1.00d would follow.
  4. Make a backup every couple of hours. I would email a copy to myself, or save a copy to my G: drive (home folder on the server) if I were working with and saving my document on a laptop, or upload a copy to my Google Docs. By the way, I have two sets of Google Docs - one for Foundation docs and the other for personal use. In a word, I make sure I have the same document in at least two places, even I have not finished it yet.
  5. I would give it a new version, either 1.10a or 2.00a, depending on how much change there would be, if I need to revise the document weeks or months after I am done with the first version. I would most likely give it a new date to mark when the major change takes place.
This may sound a bit complicated at the beginning. It will be, I can assure you, simple and easy once you stick with the practice for a short while. Start doing it now and see how it makes your life easier! Send me a warm and hearty Christmas email if it proves by then what I have here does help you! ;-)

No comments: