Tech Word

  • Subscribe to our RSS feed.
  • Twitter
  • StumbleUpon
  • Reddit
  • Facebook
  • Digg

Sunday, 7 February 2010

And the Oscar goes to...

Posted on 10:20 by Unknown
The Annual Distribution of Meaningless Awards to Shallow People, a.k.a., The Oscars, is fast approaching. This non-event is as useless as a Windows 1.0 user guide. The choices are completely subjective. Many great films and performances have lost out to lesser ones. One of the best examples of this is the masterpiece Citizen Kane, considered by many the greatest film ever made, which lost to - wait for it - How Green Was My Valley.

Now, many STC chapters have awards for technical communication. Unlike the Oscars, this is a useful awards event, if for no other reason than to have one's work judged by others. Perhaps, though, to liven things up, we need to develop sexier categories:
  • Best Looking Cover Page
  • Best Performance by an Index in a Leading Role
  • Most Graphic Use of a Graphic
  • Most Outstanding TOC
  • Most Consistent Use of A Comma Before the Word "And"
  • Best Use of Bold and Italic Simultaneously
Of course, we'd have to develop a nickname for the trophy. How about the "Writey"?

Doubling Your Pleasure

This year, the Academy has doubled the number of nominees for best picture from five to ten. The official reason is to give less successful but presumably worthy films a chance. The unofficial reason is to boost ticket sales and film rental revenue.

This idea is as dumb as a bag of Oscars. Why stop at ten nominations? Why not have twenty? Or a hundred? Just as printing money lowers its value (something the U.S. is painfully learning), increasing the number of nominated films simply lowers the value of a nomination.

Things that are important are important because there are so few of them. The important things in documentation include:
  • the important information users need to know, as highlighted in notes and warnings
  • headings, including chapter and other major headings: headings 1 through 3, for example
Therefore, if you have too many of these elements in a document, you weaken the document. For example, if you have six Important notes on a page, the reader may likely ignore them all, since if everything is important, nothing is important. Better to group all these notes as bullets under one Important Considerations section.

As for headings - again, these need to be used carefully and sparingly. Too many chapter and heading divisions in a document dilute the document. You end up with a TOC containing 47 chapters, and a chapter with 37 heading 1 sections. Instead, group numerous separate smaller sections into one large section. Split a super-sized chapter into two or more chapters. Don't force your readers to wade through a sea of sections. Combine, converge, and conquer.

By doing these things, you'll create documentation that people can actually use. This is so much more valuable than a 13.5" statue of a bald naked guy.
Email ThisBlogThis!Share to XShare to Facebook
Posted in entertainment | No comments
Newer Post Older Post Home

0 comments:

Post a Comment

Subscribe to: Post Comments (Atom)

Popular Posts

  • Six Things That Should Be Single Sourced
    Single-sourcing, as we all know, is the art and science of using a single repository of information to produce multiple outputs. Typical ex...
  • Interviewing and Dating: A Single Source Solution
    Last month, people celebrated "Valentine's Day", a day to celebrate romance and love, a day to be extra-nice to your partner, ...
  • The Power of Words
    There's nothing like an election to illustrate how powerful words are. Politicians, pundits, and the media use words to advance their ca...
  • The Governing Dynamics of Documentation
    Game theory is a specialized field of mathematics that analyzes choices and results in strategic situations, or games , as the players try t...
  • Why info systems fail
    If you only have time to read one news article today, read this one from the Financial Post. Don't leave IT to the techies - Three probl...
  • How to update a document - NOT!
    Canadian International Co-operation Minister Bev Oda needs to work on her document management skills. She hand wrote the word 'NOT'...
  • Publishing for Pollard
    Most of you probably have never heard of Jonathan Pollard, the American who has been languishing in prison since November 21, 1985, almost 2...
  • The Dynamic Blogger
    Some of you may have noticed the new look of this blog. It's a new Blogger feature called dynamic views . You can now choose how this bl...
  • Dude, where's my document?
    Try this experiment: Think of a printed guide you worked on. Find the source document from your current location. Make a minor change to the...
  • Security breach!
    It's always entertaining to read about non-lethal lapses in security at a major event. Remember the debacle at the 2010 Winter Olympics?...

Categories

  • art
  • autism
  • bad communication
  • business
  • career
  • cloud computing
  • computers
  • creativity
  • entertainment
  • finance
  • food
  • Google
  • history
  • interviewing
  • math
  • media
  • medicine
  • misc.
  • music
  • nature
  • news
  • philosophy
  • politics
  • quantum theory
  • religion
  • resume
  • resumes
  • science
  • security
  • simplicity
  • sport
  • technology
  • usability

Blog Archive

  • ►  2012 (9)
    • ►  September (1)
    • ►  August (1)
    • ►  July (1)
    • ►  April (2)
    • ►  March (2)
    • ►  February (2)
  • ►  2011 (36)
    • ►  December (2)
    • ►  November (2)
    • ►  October (6)
    • ►  September (2)
    • ►  August (4)
    • ►  July (5)
    • ►  June (3)
    • ►  May (6)
    • ►  April (2)
    • ►  February (3)
    • ►  January (1)
  • ▼  2010 (47)
    • ►  December (3)
    • ►  November (6)
    • ►  October (4)
    • ►  September (2)
    • ►  August (1)
    • ►  July (2)
    • ►  June (2)
    • ►  May (3)
    • ►  April (5)
    • ►  March (11)
    • ▼  February (7)
      • I'm sorry
      • Wall Street Journal - Free My Info!
      • The Chilean Mother of All Typos
      • Olympian glitches
      • And the Oscar goes to...
      • Recalling all recalls
      • Colour my worries away...
    • ►  January (1)
  • ►  2009 (36)
    • ►  December (11)
    • ►  November (5)
    • ►  October (4)
    • ►  September (2)
    • ►  August (2)
    • ►  July (3)
    • ►  May (1)
    • ►  April (3)
    • ►  March (2)
    • ►  January (3)
  • ►  2008 (24)
    • ►  December (9)
    • ►  November (1)
    • ►  October (7)
    • ►  July (1)
    • ►  June (1)
    • ►  May (1)
    • ►  April (1)
    • ►  March (1)
    • ►  February (1)
    • ►  January (1)
  • ►  2007 (10)
    • ►  December (1)
    • ►  November (2)
    • ►  October (4)
    • ►  August (1)
    • ►  March (1)
    • ►  January (1)
  • ►  2006 (4)
    • ►  September (1)
    • ►  June (1)
    • ►  April (1)
    • ►  February (1)
  • ►  2005 (10)
    • ►  December (1)
    • ►  November (1)
    • ►  October (1)
    • ►  September (1)
    • ►  June (1)
    • ►  May (1)
    • ►  April (1)
    • ►  March (1)
    • ►  February (1)
    • ►  January (1)
  • ►  2004 (9)
    • ►  December (1)
    • ►  November (1)
    • ►  September (1)
    • ►  June (1)
    • ►  May (1)
    • ►  April (1)
    • ►  March (1)
    • ►  February (1)
    • ►  January (1)
  • ►  2003 (9)
    • ►  December (1)
    • ►  November (1)
    • ►  September (1)
    • ►  June (1)
    • ►  May (1)
    • ►  March (1)
    • ►  February (1)
    • ►  January (2)
  • ►  2002 (3)
    • ►  December (1)
    • ►  November (1)
    • ►  October (1)
Powered by Blogger.

About Me

Unknown
View my complete profile