Best Programmers

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

Saturday, 20 December 2003

Posted on 22:47 by Unknown

Usability Testing of Your Documentation



Yea, it is possible. Let's say you have created a user-guide. The user-guide is aimed at helping users in performing various tasks on the product.



  1. Choose a representative user (anyone, even your mother-in-law is all right). If you can't recruit a user read List-item:


  2. Ask the user to perform tasks on the product using the instructions from the guide


  3. Ask the user to Think Aloud, but don't interrupt or help the user in performing tasks


  4. Make notes. Note the reactions of the user. That frown. That click of the tongue indicating frustration. People are nice; they wont tell you to your face 'Your guide sucks.' It is our duty to find out what they think


  5. Make a list of your findings; identify action points; compile a report, and go to work on the guide


  6. Once you have incorporated changes/enhancements to your guide, test it again on the user and make sure that your enhancements have made the guide usable


  7. If you can't recruit users, you and your other technical writer can review the guide (individually) against a heuristics check-list. The check-list is intended for a software application but you can use it for your guide as well, if you know what to keep and what to throw away (discretion my lord!)




Disclaimer: If you thought this idea of testing is stupid, please tell me, I am just thinking aloud and sharing the thought with you; maybe you and I can discover a method that would be world renowned, who knows!



write to me: Suman@sumankumar.com
Read More
Posted in | No comments

Friday, 5 December 2003

Posted on 03:41 by Unknown

Microsoft LongHorn Help



The next generation of the Microsoft Windows operating system, codename "Longhorn", promises to raise the standard for performance and innovation. The Windows "Longhorn" Help system is designed to greatly improve the user assistance experience in Windows.

"Longhorn" Help includes the following features:



  • A new structured authoring model enables Help authors to create higher quality Help content, leveraging the flexibility of XML.


  • A unified Help viewer pane, which is shared by all applications, provides a consistent entry point to Help.

  • A new organizational structure based on common tasks, rather than application features, makes it easier for users to find the Help they need.


  • Active content displays the most appropriate Help content, based on the current state of the user's computer.

  • A more efficient update model continuously provides connected users with the newest content; each update contains only updated material, which conserves bandwidth.


Links:



Longhorn page on MSDN

About Microsoft Assistance Markup Language (MAML)



Note: Learn XML buddy; that's where the future is. In probably a couple of years organizations will start mentioning this in their recruitment ads for tech writers: "Help authoring skills using 'Longhorn' (or whatever the actual name is; Longhorn is just a code-name)"

Tools Die. Concepts don't. Get it?



write to me: Suman@sumankumar.com
Read More
Posted in | No comments
Newer Posts Older Posts Home
Subscribe to: Posts (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)
      • Usability Testing of Your DocumentationYea, it is ...
      • Microsoft LongHorn HelpThe next generation of the ...
    • ►  November (3)
    • ►  October (1)
    • ►  September (3)
    • ►  August (7)
    • ►  July (2)
    • ►  June (1)
    • ►  April (4)
    • ►  February (4)
    • ►  January (15)
Powered by Blogger.

About Me

Unknown
View my complete profile