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:Documenting running water From:"Delaney, Misti" <ncr02!ncr02!mdelaney -at- UCS01 -dot- ATTMAIL -dot- COM> Date:Tue, 20 Jun 1995 13:19:00 -0500
HELP!
We are documenting a very complex system (6 modules with probably in excess
of 300 screens, and it's changing every day) that is constantly changing:
our primary users are also the beta testers for the user interface. Not
only are new screens being added, but existing screens are being modified:
fields added or changed (in some cases, the field itself *looks* the same,
but it's *use* and *meaning* have changed!)
We can get our help files out there (if the developers bother to put in the
hooks!) BUT -
any suggestions on how we can indicate to our users that there may be new
information since the last time they looked at the help file?
Note too: our help files are primarily extended field description tables.
There are some generic procedures (how to add a record for most screens,
how to find information on most screens, etc.) and some screen-specific
procedures where they apply. We know that this is not optimal, but it's the
situation we inherited and were directed to use. the plan for making the
transition from this reference-orientation to more of a process orientation
is to have the users give us feedback on what they need that isn't there,
and then we'll put it in. this also is not optimal, but again we're stuck
with it for the time being. *sigh* it's a political thing.
We're also looking for new techniques for revision control so that
individual pages (screens) can be updated without.
a) re-releasing the entire module every time or
b) setting up each page as its own section to let us put individual
footers on
each page.