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: How do you document customized windows? From:Kathi Jan Knill <Kathi -dot- Knill -at- TEMPLATE -dot- COM> Date:Tue, 24 Aug 1999 16:24:21 -0400
Oh what a nightmare!!!! This is my worst fear...that I'd have to
document software that not only has changing requirements (which
as we all know is hard enough). But also will be forever in the
state of flux....Yikes.
Anyway, in order to supply an answer or at least attempt to
supply one, I would like to know...
Are you saying that the client's account manager can only change
the labels to the fields, or are you saying that they can
literally hide fields that they don't want to show?
Kathi Jan Knill
Sr. Technical Writer
Template Software, Inc.
kathi -dot- knill -at- Template -dot- com
Life loves to be taken by
the lapel and told:
"I'm with you kid. Let's go."
----- Original Message -----
From: Michelle Vina-Baltsas <Michelle_Vina-Baltsas -at- US -dot- CRAWCO -dot- COM>
To: <TECHWR-L -at- LISTSERV -dot- OKSTATE -dot- EDU>
Sent: Tuesday, August 24, 1999 4:04 PM
Subject: How do you document customized windows?
> Hi again,
>
> I'm currently writing an HTML help file for a software product
that can be
> customized based on client specifications. Text box labels,
required fields,
> and forms, etc. can all be changed by the clients account
manager. My dilemma
> is... how to document an application that could potentially
look different for
> every client? I've added a disclaimer statement to the help
file alerting them
> that their screens may look different, but thought you might
have some
> interesting experience with this sort of scenario. This is a
rough example of
> what I'm proposing:
>
> To add an adjuster note, follow these steps:
>
> From the Claim Summary sub-form, click Adjuster Notes. The
Adjuster Notes
> list appears.
> Click the Add Note button. The Adjuster Notes sub-form
appears.
> Enter the appropriate information, then click the Save Note
button.
> Click the Cancel Add button to close the sub-form without
saving the note.
>
>
> Any suggestions?
>
> TIA,
> Michelle
>
>
>
=================================================================
==========
> Send commands to listserv -at- listserv -dot- okstate -dot- edu (e.g., SIGNOFF
TECHWR-L)
> Search archives at: http://www.raycomm.com/techwhirl/archives.htm
> Find recommended books at http://www.raycomm.com/techwhirl/books.htm
> Send all list-related questions or problems to
>