Re: Documenting a "wizard"

Subject: Re: Documenting a "wizard"
From: Tony Chung <tonyc -at- tonychung -dot- ca>
To: Hannah Drake <hannah -at- formulatrix -dot- com>
Date: Thu, 8 May 2014 17:59:04 -0700

Tell the following to your colleague. And then maybe you'll get buy in for
"documenting a wizard is redundant; if a wizard needs documentation, it
isn't a wizard."

-Tony


On Thursday, May 8, 2014, Tony Chung <tonyc -at- tonychung -dot- ca> wrote:

> Oh heck. Why not? Users need so much hand holding that you should display
> every single screen shot and provide sample data.
>
> You probably don't have enough to do and need to build in some job
> security. Screen shots guarantee that you'll be needed to update the
> documents every time the interface changes.
>
> Oh, and you should document the way the wizard works in each operating
> system. Users may be confused when they see the Mac dialog boxes but they
> have Windows computers. You know how that goes.
>
> -T
>
> On Thursday, May 8, 2014, Hannah Drake <hannah -at- formulatrix -dot- com<javascript:_e(%7B%7D,'cvml','hannah -at- formulatrix -dot- com');>>
> wrote:
>
>>
>> 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.
>>
>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
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: Tony Chung

Previous by Author: Re: Documenting a "wizard"
Next by Author: Re: "The Value of Recording Conversations with SMEs"
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