TechWhirl (TECHWR-L) is a resource for technical writing and technical communications professionals of all experience levels and in all industries to share their experiences and acquire information.
For two decades, technical communicators have turned to TechWhirl to ask and answer questions about the always-changing world of technical communications, such as tools, skills, career paths, methodologies, and emerging industries. The TechWhirl Archives and magazine, created for, by and about technical writers, offer a wealth of knowledge to everyone with an interest in any aspect of technical communications.
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.
