Best Programmers

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

Monday, 20 January 2003

Posted on 21:01 by Unknown

Writing Web Help



I have been working on online help for the past year. When it started I was overawed at the size of the product and the documentation we had to prepare. But I learnt a lot on my way. Here are some tips that you might find useful

  1. Users don't read text on browsers. They scan. So highlight keywords, action words ('do this, do that')
  2. Cut down 50% of what you have written. Brevity can't be stressed enough. Please remember that reading speed on a computer screen decreases by about 20-25%
  3. Write in active voice
  4. Write 'action first. Effect later' (example: Click 'OK'. To go to the homepage. AND NOT 'To go to the homepage click 'OK')
  5. Write to a singular audience: Imagine that the user is sitting infront of you and you're telling him/her how to perform a task. People don't use your software in groups
  6. Iterative document design:Build a prototype. Test in on users. Build. Test. Build Test... of what value your documenation is if it doesn't help me in performing tasks? I can't take it to bed to read it like a novel!
    Email ThisBlogThis!Share to XShare to Facebook
Posted in | No comments
Newer Post Older Post Home

0 comments:

Post a Comment

Subscribe to: Post Comments (Atom)

Popular Posts

  • Use it before you write it.
    From the Nikkor ED 80-400mm f/4.5-5.6D VR Review (emphasis is mine): [quote] Here's the warning in the manual : "When the camera is...
  • Participative Help Design
    Participative Help Design I used a weblog script to create online help for -uh- using weblogs. I used a plugin to pull help topics as alphab...
  • 3rd STC Chennai Meet this sunday.
    3rd STC Chennai Knowledge Sharing Session this sunday, April 4th. This month's knowledge sharing session will be held this coming sunday...
  • Firefox: Tech writer friendly!
    Firefox has an in-built popup blocker. Firefox saves your screenspace through its tabbed-browsing feature. Firefox allows for opening mult...
  • Engrish!
  • Context Sensitive 'Sticky Notes': Stick a Sticky Note to your Blog!
    Conceptworld's Quick Notes Plus might appear like any other Sticky Notes Plus (QNP) program, but its context-sensitive notes feature is...
  • Writing SI units and symbols
    Quite a few of us do not write the SI units correctly. If you are a Physics or Chemisty student, and still remember what you studied in scho...
  • Finding the voice
    Excerpt from LOUIS MENAND's review of Eats, Shoots & Leaves: The Zero Tolerance Approach to Punctuation” (Gotham; $17.50), by Lynne ...
  • The Personable Manual
    Why do product manuals sound formal and stiff-upper-lipped? Why don’t users read manuals? These questions have haunted the hallowed precinct...
  • Tech-writers – A Necessary Evil
    In a world where accuracy is all important, a lot goes over the head of the dummy. I don't know if it's intellectual snobbery, but p...

Categories

  • conferences
  • contigency design
  • culture
  • design
  • error messages
  • google
  • hall of shame
  • ideas
  • management
  • manual
  • standards
  • stc
  • strategy
  • tools
  • usability
  • writing

Blog Archive

  • ►  2009 (1)
    • ►  February (1)
  • ►  2008 (5)
    • ►  November (1)
    • ►  September (1)
    • ►  May (2)
    • ►  April (1)
  • ►  2007 (7)
    • ►  October (1)
    • ►  August (2)
    • ►  June (1)
    • ►  March (1)
    • ►  January (2)
  • ►  2006 (10)
    • ►  November (2)
    • ►  October (3)
    • ►  September (1)
    • ►  August (3)
    • ►  June (1)
  • ►  2005 (17)
    • ►  December (2)
    • ►  November (1)
    • ►  October (3)
    • ►  September (2)
    • ►  August (3)
    • ►  June (2)
    • ►  May (1)
    • ►  April (2)
    • ►  February (1)
  • ►  2004 (32)
    • ►  December (4)
    • ►  November (1)
    • ►  October (3)
    • ►  September (3)
    • ►  August (2)
    • ►  July (5)
    • ►  June (3)
    • ►  May (1)
    • ►  April (5)
    • ►  March (2)
    • ►  February (1)
    • ►  January (2)
  • ▼  2003 (42)
    • ►  December (2)
    • ►  November (3)
    • ►  October (1)
    • ►  September (3)
    • ►  August (7)
    • ►  July (2)
    • ►  June (1)
    • ►  April (4)
    • ►  February (4)
    • ▼  January (15)
      • User Manual for Building Your Own PlaneThe manual ...
      • How to save your client $1600 per task per year th...
      • Job posting: Thanks to the TWIN ListI haven't link...
      • Role of a Technical Writer: Mail to the TWIN ListL...
      • Hi A first post here ... check this link which car...
      • Writing Web HelpI have been working on online help...
      • Calling all Graphic DesignersSo you think you got ...
      • HI friends,I suggest we should have some good Tech...
      • Job Posting: European Co Looking for a Tech Writer...
      • Framemaker to Word ConversionPeople, any idea abou...
      • Toilet UI design (source: Prasanna from TWIN list)...
      • Directory of Technical Writers in Chennai : Hi ! ...
      • Interviewing the TechiesMy current project involve...
      • What is Technical Communication?It's the process o...
      • Technical Writers of IndiaWelcome this is the firs...
Powered by Blogger.

About Me

Unknown
View my complete profile