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: Help Topic for every window in application - confirming
Subject:RE: Help Topic for every window in application - confirming From:"Bruce Megan (Telex)" <Megan -dot- Bruce -at- us -dot- bosch -dot- com> To:<admin -at- techwr-l -dot- com>, "TECHWR-L" <techwr-l -at- lists -dot- techwr-l -dot- com> Date:Wed, 10 Sep 2008 12:29:54 -0500
Although probably not the easiest choice, but when I write help, I
factor in 2 to 3 days to sit with the application and write out (type)
each of the fields in the program. Although tedious, it does help better
understand the program I am going to be working with. AND, if your
programmer is like mine, the MapIDs are turned on in the program, I
combine getting each MapIP with understanding the app.
I guess I am a glutton for punishment.
My .02 worth.
Megan Bruce
Documentation Specialist
Bosch Communications Systems
Telex Communications Inc.
12000 Portland Ave. S.
Burnsville, Minnesota 55337
USA
www.boschcommunications.com mailto:megan -dot- bruce -at- us -dot- bosch -dot- com
-----Original Message-----
From: techwr-l-bounces+megan -dot- bruce=us -dot- bosch -dot- com -at- lists -dot- techwr-l -dot- com
[mailto:techwr-l-bounces+megan -dot- bruce=us -dot- bosch -dot- com -at- lists -dot- techwr-l -dot- com] On
Behalf Of TECHWR-L Administrator
Sent: Wednesday, September 10, 2008 12:21 PM
To: 'TECHWR-L'
Subject: FWD: Help Topic for every window in application - confirming
Forwarded anonymously on request -- please respond to the list.
&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&
I want to be sure that I have a help topic for every window and dialog
in a software application. I have most of them documented. I may even
have ALL of them, but I can't be sure. The app was written using MS
Visual Studio. I hoped that VisStudio would have a way to generate a
list of all windows and dialogs for the app, but apparently it doesn't.
This would be easy if there were specs and design plans. There aren't.
Not my call. Nothing I can do about that.
This is a complex application and simply trying to follow all the
various options and navigation paths is a dicey way to gather
information. I'd rather not involve the developers if I can help it
because they're already busy enough.
So, without specs, how do you determine whether you've written help for
every single window and dialog in an application? Any suggestions?
&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&
Forwarded anonymously on request -- please respond to the list.
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
ComponentOne Doc-To-Help gives you everything you need to author and
publish quality Help, Web, and print content. Perfect for technical
authors, developers, and policy writers. Download a FREE trial. http://www.componentone.com/DocToHelp/
True single source, conditional content, PDF export, modular help.
Help & Manual is the most powerful authoring tool for technical
documentation. Boost your productivity! http://www.helpandmanual.com
---
You are currently subscribed to TECHWR-L as megan -dot- bruce -at- us -dot- bosch -dot- com -dot-
ComponentOne Doc-To-Help gives you everything you need to author and
publish quality Help, Web, and print content. Perfect for technical
authors, developers, and policy writers. Download a FREE trial. http://www.componentone.com/DocToHelp/
True single source, conditional content, PDF export, modular help.
Help & Manual is the most powerful authoring tool for technical
documentation. Boost your productivity! http://www.helpandmanual.com
---
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-
