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.
In my limited SW documentation work it has depended on the screen.
If it's a monitoring screen, we identified every readout. If a working
screen with no particular order to use, likewise. In cases where the
user would probably never bring the screen up except to perform
specific operations, sometimes not at all.
Gene Kim-Eng
----- Original Message -----
From: "Michelle Vina-Baltsas" <Michelle_Vina-Baltsas -at- datascope -dot- com>
To: <techwr-l -at- lists -dot- techwr-l -dot- com>
Sent: Wednesday, April 25, 2007 1:33 PM
Subject: Identifying window components in SW apps
> For those writers who document software applications, when you are
> describing a window/screen, do you identify every part of the
> window/screen or do you only specify the parts that aren't obvious? We
> typically identify all parts and pieces, but I'm wondering if this is over
> kill. I know this answer will be partly based on the audience, but I want
> to know what others consider in making this decision.
>
> Thank you,
> Michelle Vina-Baltsas
> Technical Writer
> Datascope Corporation, Patient Monitoring
> 201.995.8350
> michelle_vina-baltsas -at- datascope -dot- com
> ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
>
> Create HTML or Microsoft Word content and convert to Help file formats or
> printed documentation. Features include support for Windows Vista & 2007
> Microsoft Office, team authoring, plus more.
>http://www.DocToHelp.com/TechwrlList
>
> Now shipping: Help & Manual 4 with RoboHelp(r) import! New editor,
> full Unicode support. Create help files, web-based help and PDF in up
> to 106 languages with Help & Manual: http://www.helpandmanual.com
>
> ---
> You are currently subscribed to TECHWR-L as techwr -at- genek -dot- com -dot-
>
> To unsubscribe send a blank email to
> techwr-l-unsubscribe -at- lists -dot- techwr-l -dot- com
> or visit http://lists.techwr-l.com/mailman/options/techwr-l/techwr%40genek.com
>
>
> To subscribe, send a blank email to techwr-l-join -at- lists -dot- techwr-l -dot- com
>
> Send administrative questions to admin -at- techwr-l -dot- com -dot- Visit
>http://www.techwr-l.com/ for more resources and info.
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Create HTML or Microsoft Word content and convert to Help file formats or
printed documentation. Features include support for Windows Vista & 2007
Microsoft Office, team authoring, plus more. http://www.DocToHelp.com/TechwrlList
Now shipping: Help & Manual 4 with RoboHelp(r) import! New editor,
full Unicode support. Create help files, web-based help and PDF in up
to 106 languages with Help & Manual: http://www.helpandmanual.com
---
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-
