Documenting a "wizard"

Subject: Documenting a "wizard"
From: Hannah Drake <hannah -at- formulatrix -dot- com>
To: techwr-l <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Thu, 8 May 2014 17:47:16 -0400

Hey all,

We are releasing a new wizard that walks a user through a process. The
other person thinks the wizard should be documented for the users. My
argument is it's redundant, because the wizard explains exactly what it is
IN the wizard itself (I know because I wrote the text and helped design the
wizard). I also pointed out that if we have to document the wizard, we
failed at creating a useful wizard.

The only place we currently mention the wizard in documentation is in a
topic that talks about the various ribbon menus and what you can do on each
ribbon, when we say: this button launches the such-and-such wizard.

Thoughts? Am I wrong here?

Doc-To-Help 2014 v1 now available. SharePoint 2013 support, NetHelp enhancements, and more. Read all about it.

Learn more:


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 for more resources and info.

Looking for articles on Technical Communications? Head over to our online magazine at

Looking for the archived Techwr-l email discussions? Search our public email archives @


Previous by Author: Re: More about the changes coming to tech writing
Next by Author: Re: Documenting a "wizard"
Previous by Thread: Re: Do tech writers write Engineering test reports?
Next by Thread: Re: Documenting a "wizard"

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

Sponsored Ads