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: Identifying window components in SW apps From:Janice Gelb <janice -dot- gelb -at- sun -dot- com> To:techwr-l -at- lists -dot- techwr-l -dot- com Date:Thu, 26 Apr 2007 07:27:07 +1000
Michelle Vina-Baltsas wrote:
> 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.
>
We now rarely provide screenshots of windows or
screens with callouts unless the interface is
potentially confusing, and even then we only
identify major parts of the interface. We finally
realized that the only time most users were
interested in the parts of the interface was when
they actually had to use them to do something so we
now only mention the parts of the GUI within the
tasks where the user needs to engage them.
-- Janice
***********************************************************
Janice Gelb | The only connection Sun has with
janice -dot- gelb -at- sun -dot- com | this message is the return address
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-