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.
Re: Task Oriented Documentation For Non-Task-Oriented Software
Subject:Re: Task Oriented Documentation For Non-Task-Oriented Software From:Tim Altom <taltom -at- SIMPLYWRITTEN -dot- COM> Date:Sat, 28 Aug 1999 15:04:17 -0500
You've posited two different questions here. The answer to the first
question, "Can task-oriented manuals be done in this environment?" is "yes".
We do such things using Clustar. We had a recent client who had such
intensely screen-based software, but the manual was written task-based, as
Clustar encourages.
But as you note, writing it that way will undoubtedly point out the true
orientation of the software design, so there's a second question "Should we
do this?" Management has to answer that. In our client's case, they let us
do it. Not every company is so understanding.
Tim Altom
Simply Written, Inc.
Featuring FrameMaker and the Clustar Method(TM)
"Better communication is a service to mankind."
317.562.9298 http://www.simplywritten.com
----- Original Message -----
From: Anthony Markatos <tonymar -at- HOTMAIL -dot- COM>
To: <TECHWR-L -at- LISTSERV -dot- OKSTATE -dot- EDU>
Sent: Saturday, August 28, 1999 11:59 AM
Subject: Task Oriented Documentation For Non-Task-Oriented Software
>Question to all listserv members:
>
>In creating end user documentation for an existing (complex) software
>package, if the software was NOT designed task oriented, can the end user
>manual be written in such a fashion?
>
>Typically, to accomplish a given end user task with our software, you have
>to travers up-and-down through several (seemingly totally unrelated) menus.
>
>Problem: When you write task oriented documentation for this sofware (i.e.
>bring all required menu selections together under the specific task), the
>lack of task oriented design becomes glaringly evident. The documentation
>acutally prompts the end user to ask the question "Why do I have to do so
>much jumping around between menus to accomplish a given task?" This does
>not make us look good.
>
>All responses appreciated.
>
>Tony Markatos
>(tonymar -at- hotmail -dot- com)
>
>
>______________________________________________________
>Get Your Private, Free Email at http://www.hotmail.com
>
>From ??? -at- ??? Sun Jan 00 00:00:00 0000==
>
>
>
>
