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.
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?
-Hannah
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Doc-To-Help 2014 v1 now available. SharePoint 2013 support, NetHelp enhancements, and more. Read all about it.