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:RE: Product Help vs. Application Help From:"Richard" <richard -dot- smith -at- windriver -dot- com> To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Mon, 18 Nov 2002 10:26:30 -0800
I can think of an example. Many SDKs include both an application component
(compiler, debugger, visualization tools, etc.), and a library component.
The *product* is the GUI tools and the libraries together. The application
is the desktop tools.
It is easy to see how both of these should be included in help. For example,
I might want to know what to click to set a breakpoint. That is clearly an
application help issue. Then I might want to know how I use the
AceInterview() method. That is clearly a help issue related to the product,
and not the desktop application. At least that's how I would interpret it.
hth
--
Richard Smith
Technical Writer
Network Infrastructure Group
Networks Business Unit
www.windriver.com
| From: <rajancs2002 -at- yahoo -dot- com>
| > Can anyone tell me what is the difference between creating
| help for a
| > software product and creating help for a software
| application (project)?
| >
|
| First, what is the difference between a software "product"
| and a software
| "application"? They seem like synonyms to me.
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
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.
