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:Documentation Vs. Program Responsibility From:"William B. MacLeod" <WBMACLE -at- ACCUSORT -dot- COM> Date:Fri, 18 Aug 1995 13:19:08 EST4EDT
I am wondering how you all feel about the following:
If you are writing software documentation (non GUI software), and
the screen has function keys; such as F1-PREV, F2-NEXT, F3-END,
and the software tells the user that they have reached the end or
beginning of the database, report, etc. via a message on the screen,
Do you feel it is necessary to also explain that this is going to
happen in the documentation.
A more general question would be, should the documentation reiterate
things that are already somewhat user freindly in the program?
Thanks for your input in advance.
----------------------------------------------------------------------------
William MacLeod wbmacle -at- accusort -dot- attmail -dot- com
Technical Publications Manager +1 215.721.5093
Accu-Sort Systems
The opinions in this message are my own
----------------------------------------------------------------------------
