Re: Documenting a "wizard"

Subject: Re: Documenting a "wizard"
From: Gene Kim-Eng <techwr -at- genek -dot- com>
To: Hannah Drake <hannah -at- formulatrix -dot- com>
Date: Thu, 8 May 2014 15:39:02 -0700

There is a place where you would want to document the wizard step-by-step,
but it's not the end user doc. It would be in the internal software
spec/API document. The user doc shouldn't need anything more than a blurb
that says what the wizard is for and an instruction to the user to follow
the on-screen prompts.

Gene Kim-Eng


On Thu, May 8, 2014 at 2:47 PM, Hannah Drake <hannah -at- formulatrix -dot- com> wrote:

> 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
>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
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

Previous by Author: Re: Do tech writers write Engineering test reports?
Next by Author: Re: OT: Documenting a "wizard"
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