Avoiding scope-creep in writing projects

June 24th, 2008

Some organisations simply have nothing written down before we start working with them. They tend to envision that we’ll produce some sort of ‘magic manual’ that will fix all of their documentation problems. This is wrong on so many levels, but how do you explain it to the client?

Here’s a way that works. Draw a picture like the one below - it’s a chart in which one axis represents the length of time for which the intended audience has had a relationship with your client, the organisation you’re writing for - in this example we’ve labelled the two extremes as ‘pre-sales’ and ‘post-sales’. The other axis presents a view of  the spectrum of audience types - in this case from management to technical people.

blankmatrix2002.png

Now you can start to talk with stakeholders, and map out where proposed documents actually live on the diagram. For example, on the following version, we’ve identified where we think a set of API-related technical documentation should live, together with a marketing brochure and a technical datasheet.

populatedmatrix.png

In all of this, we’re obeying the golden rule - any document can only address at most one of the small red sectors plus its immediate neighbours. If a client suggests that you write for an audience that includes everyone from senior management to the downright technical, you can draw a diagram like the one below and show him/her that the scope is wrong.

wrongmatrix.png

The more focused an audience, the more a piece of writing can do the job properly - the magic manual above is trying to do too many jobs for too many people, and will fail miserably.

Obviously, the diagram can be customised to your own circumstances, but it’s proved to be useful in many projects, from writing specialised marketing literature to documenting event-driven APIs for embedded hardware.

Adding sparkle to business writing #1

October 23rd, 2007

We spend a lot of our time with corporations who need to produce detailed commercial proposals. If it’s possible, we quite often write the whole things ourselves. If not, we help out by instilling a little structure and process, rolling up our sleeves and joining the editing team. This way of work helps us - by giving us lots of variety and exposing us to different ways of working. It also helps our clients, because we can bring best practice gleaned from many companies to our new projects. No bid will ever win a literary prize, but it is possible to engage the reader and make him or her eager to continue - regardless of how dry the subject matter is. And the great thing about this is that you don’t need a literature degree to start adding a little sparkle to your own business writing. That’s right, there’s an easy trick we can all use.

Lists and the brain

If you’ve ever had responsibility for contributing to a bid, it’s likely you’ll have structured your work by making a list first. This is a good idea - much better to rough-out the shape of your contribution than to dive straight into the detail. A beautiful list can be the beginning of a great passage of business writing. Most of us will have a tendency to produce lists whose elements are grammatically parallel. Asked to write about fruit, we might produce a list that starts with ‘apple’, ‘orange’, ‘pear’, and ‘banana’ - not ‘apple’, ‘yellow’, ‘juicy’ and ’spherical’.

The same thing happens in business writing. If we needed to write about our approach to Internet security, we might start:

  1. Security
  2. Intrusion
  3. Firewalls
  4. Viruses

So far so good, let’s develop our list into a tentative paragraph:

 ”Security will be managed centrally at our data centre. Intrusion attempts will be addressed by a number of measures. Firewalls will be configured to permit access only by authorised persons or agents. Viruses will be detected and processed outside the firewall.”

… and so on. Pretty awful eh? And I know this is just an example, but we’ve all seen stuff like this turn up in bids - and we don’t know who to feel most sorry for, our zombie who had to write it, or the client’s zombie who’s gotta read it!

Rewrite those list-inspired sentences

What’s gone on in the above example is that we’ve used our list to guide the structure of the sentences in our paragraph. And because the list’s elements were grammatically parallel, it’s not surprising that we’ve written sentences that also happen to be grammatically parallel. But the problem with that is as a reader, the big editor in our head doesn’t like parallel sentences. He finds them hard to unpick, laborious to parse, turgid … and in a word, boring.

Very many bid writers - especially if they’re time-constrained - make the mistake of leaving their paragraphs at the same stage as the one above. Better writers will take this initial paragraph and rewrite it to add a little texture and prevent the sentences looking as if they all came from the same sentence cookie cutter. A good writer will experiment with the positions of the subject and the object in each sentence, reinterpreting it until it has a little zing.

Here’s a tiny rewrite to demonstrate my point:

 ”Our high-performance data centre has many security features, and is equipped with powerful measures to foil intrusion attempts. Modern firewalls are specially configured to permit only authorised connections, and incoming email messages are purged of viruses before being allowed inside the network”.

OK I admit it, it’s still not going to win any literary prizes, but I hope you agree that it’s got a bit more sparkle and purpose than our first effort. Applying this rewriting technique across a whole proposal can really help breathe a little life into it, and, more importantly, give your reader - your potential customer - something to carry on living for!

Keyboard Shortcuts

September 12th, 2007

Excel - Moving and scrolling within worksheets

Move one cell up, down, left or right -> Arrow keys

Move one cell to the right -> TAB

Move one cell to the left -> SHIFT+TAB

Move to the edge of the current data region -> CTRL+arrow key

Move to the beginning of the row -> HOME

Move to the beginning of the worksheet -> CTRL+HOME

Move to the last cell of the worksheet, in the bottom-most used row of the rightmost used column -> CTRL+END

Move down one screen -> PAGE DOWN

Move up one screen -> PAGE UP

Move one screen to the right -> ALT+PAGE DOWN

Move one screen to the left -> ALT+PAGE UP

Switch to the next pane in a worksheet that has been split -> F6

Switch to the previous pane in a worksheet that has been split -> SHIFT+F6

Scroll to display the active cell ->CTRL+BACKSPACE

Display the Go To dialogue box -> F5

Display the Find dialogue box -> SHIFT+F5

Repeat the last Find action -> SHIFT+F4

Move between unlocked cells in a protected worksheet -> TAB

White papers

August 24th, 2007

Ghost-written journal article for Fujitsu describing a collaborative project intended to assess how an innovative Japanese development methodology could bring value to the company’s UK managed IT service operations.

A BT/Oracle white paper describing their solution to asset lifecycle management in the utilities and transport sectors.

A white paper for Systems Union, presenting their 2006 technology strategy.

Company-i (later acquired by Symantec) commissioned a white paper on the potential for shared computing to improve space, power and compute capabilities in today’s overcrowded datacentres.

A product overview paper for a large financial and performance management organisation.