Shaun Mccran

My digital playground

22
J
A
N
2011

It is all about the punctuation

More and more recently I find myself writing documentation rather than code. I'm referring to real business documentation, rather than docs about technology.

I've noticed more and more that in documents its often not what you say, but the manner in which you say it. I'm sure there are dozens of best practices for writing good business documents, things like keeping it succinct or not too flowery or overly wordy.

One thing I have noticed is that my punctuation is mediocre at best. After mentioning this to a colleague he sent me the text below.

It is the same text, but with differing punctuation. It conveys a totally different meaning, simply because the punctuation is arranged differently.

Example one

view plain print about
1Dear John,
2I want a man who knows what love is all about. You are generous, kind, thoughtful. People who are not like you admit to being useless and inferior. You have ruined me for other men. I yearn for you. I have no feelings whatsoever when we're apart. I can be forever happy -will you let me be yours?
3
4Gloria

Example two

view plain print about
1Gloria
2
3Dear John,
4I want a man who knows what love is . All about you are generous, kind, thoughtful people, who are not like you. Admit to being useless and inferior. You have ruined me. For other men, I yearn. For you, I have no feelings whatsoever. When we're apart, I can be forever happy. Will you let me be?
5
6Yours,
7Gloria

I thought I'd share it, its genius really. Makes me think that perhaps my next training course may not be technology based, it may be documentation based.

TweetBacks
Comments (Comment Moderation is enabled. Your comment will not appear until approved.)
bex's Gravatar I hate 'flowery' words...... just say it how it is! Hopefully that way we can all understand and agree it! ; P
# Posted By bex | 22/01/2011 12:20
Steve Bryant's Gravatar Great example of the importance of punctuation!

The first example has an extra "yours" at the end. I think it should just be "Yours? Gloria"
# Posted By Steve Bryant | 22/01/2011 13:44
Shaun McCran's Gravatar @Bex floweryness is a real danger in documents, being able to get across your point in a language thats acceptable for the audience is a real skill.

@Steve, glad you liked it. Good spot, I've amended it, thanks.
# Posted By Shaun McCran | 22/01/2011 14:44
kris's Gravatar I saw that example in a book called "Eats shoots and leaves". Awesome book on punctuation. Wow, I just exposed how geeky I am.
# Posted By kris | 22/01/2011 16:44
Dominic Watson's Gravatar A possible regrammatisation of the first sentence in the second paragraph:

"I have noticed, more and more, that in documents it is often not what you say, but the manner in which you say it."

Personally, and too often, I find myself using clauses in sentences to a point that must be infuriating to anyone reading my written words. I easily find six or more commas in my sentences; potentially appropriate for an epic poem, disastrous for a technical document or guide.

Love the example, created surely by the minds from Mensa.
# Posted By Dominic Watson | 23/01/2011 20:41
Shaun McCran's Gravatar @Dominic, Thanks for the re-write, your version does flow more clearly than mine.

It is a great example, I really love the fact that someone has been smart enough to use exactly the same text to a hugely different outcome. I don't often see 'art' in words, but this has shown me something different.
# Posted By Shaun McCran | 23/01/2011 22:03
Back to top