Hints for writing business documentation

May 21st, 2005

As a cynical and arrogant person (acceptance is the first step ;) ) I often find writing corporate documentation to be a tricky task, as I’m often interrupted by clients and other distractions (maybe some subtle ADD too?) so my documentation tends to come out very “chatty” and ultimately unprofessional looking. More often than not my documentation arrives packed with snide remarks too, which while hilarious to my workmates, still probably isnt a good thing in the long run.

So folks it’s very simple:
* Remove distractions
* Give the document structure – go through and create all the section headings first
* Think about what you’re trying to achieve with the document, jot notes, brainstorm and keep it all within your achievement goals
* Executive Summary is the first part of the documentation but the last part created
* Whenever you feel a mental block, print out the document, staple/bind it and go sit somewhere else with a pen. Jot notes and error corrections on the printout. When you’re feeling more inspired, go back to your computer and update the electronic version. Any large literary creation of mine can be printed out 20 or 30 times before I’m satisfied that it’s mediocre. Consistent, but mediocre.
* Get someone else to read it and make comments, keeping target audience and purpose in mind
* Make sure that that particular someone else has an intelligence level equal to or greater than yours
* If it has sensitive information in it, make sure that someone else is privvy to said information and also contains the ability STFU

I’ve done more with a particular business case today than I have in the last two weeks. Remarkable.