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