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.
Subject:Product help vs. application help? From:"Liz Goodwin" <Liz -dot- Goodwin -at- ametek -dot- com> To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Mon, 18 Nov 2002 11:27:25 -0500
C.S.Rajan wondered: <<Can anyone tell me what is the difference between
creating help for a software product and creating help for a software
application (project)? I was asked this question in an interview.>>
Looking at it from the point of view of someone who writes documentation
for hardware that involves software and not someone who write documentation
for software that goes out to different customers. . .
Software Product Requirements for installing the product and how to
manipulate the product in a generic sense - getting up and running and
comfortable.
Software Application Once the product is installed and the user knows
how to open, close, navigate, etc. how to apply the more sophisticated
capabilities of the product to the user's application.
For instance, we produce high-tech instrumentation of various levels that
use the same software. However, the user's need (application) determines
how involved in the software he needs to get. This in turn depends on the
number of gas streams and calibrations streams in a process as well as what
specifically the user is looking for or doesn't want to find. More
sophisticated applications require more in-depth documentation.
I can use a program like Pagemaker to design a brochure or I can use it to
write a 300-page manual. Both are different applications using the same
software program. One does not necessarily require that you know how to do
the other to oeprate the software.
Just my take on it.
Liz Goodwin
Technical Writer, Process Instruments
AMETEK, P&AI
liz -dot- goodwin -at- ametek -dot- com
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Check out SnagIt - The Screen Capture Standard!
Download a free 30-day trial from http://www.techsmith.com/rdr/txt/twr
Find out what all the other tech writers, including Dan, already know!
Order RoboHelp X3 in November and receive $100 mail in rebate, FREE WebHelp
Merge Module and the new RoboPDF - add powerful PDF output functionality
to RoboHelp X3. Order online today at http://www.ehelp.com/techwr-l
---
You are currently subscribed to techwr-l as:
archive -at- raycomm -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- raycomm -dot- com
Send administrative questions to ejray -at- raycomm -dot- com -dot- Visit http://www.raycomm.com/techwhirl/ for more resources and info.
