Re: Documenting a "wizard"

Subject: Re: Documenting a "wizard"
From: Robert Lauriston <robert -at- lauriston -dot- com>
To: techwr-l <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Fri, 9 May 2014 16:11:16 -0700

The only time documentation is required for a wizard is when you have
an unusable one that a pointy-haired manager won't let you fix.

A real wizard is, by definition, self-documenting. If there's anything
documentation could add that''s not on screen, it must be added to the
wizard. As Hannah made clear in follow-up posts she wrote the wizard
text and put everything in there.

One place I worked I inherited a project where my predecessors had
actually written a context-sensitive help topic for every page of
every wizard that simply repeated what was on that page. There were
around 60 topics that had nothing but a screen shot of the last page
of various wizards with the instruction, "Click Finish."
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Doc-To-Help 2014 v1 now available. SharePoint 2013 support, NetHelp enhancements, and more. Read all about it.

Learn more: http://bit.ly/NNcWqS

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-

To unsubscribe send a blank email to
techwr-l-leave -at- lists -dot- techwr-l -dot- com


Send administrative questions to admin -at- techwr-l -dot- com -dot- Visit
http://www.techwhirl.com/email-discussion-groups/ for more resources and info.

Looking for articles on Technical Communications? Head over to our online magazine at http://techwhirl.com

Looking for the archived Techwr-l email discussions? Search our public email archives @ http://techwr-l.com/archives


References:
Documenting a "wizard": From: Hannah Drake
Re: Documenting a "wizard": From: Keith Hood

Previous by Author: Re: Documenting a "wizard"
Next by Author: Re: Hardware upgrade with Windows 7 already installed
Previous by Thread: Re: Documenting a "wizard"
Next by Thread: Re: Documenting a "wizard"


What this post helpful? Share it with friends and colleagues:

Sponsored Ads


Sponsored Ads