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: To document Windows functions or not? From:joanne grey <j -dot- grey -at- WORLDNET -dot- ATT -dot- NET> Date:Mon, 16 Dec 1996 17:30:02 -0800
Bruce Brill wrote:
> I work for a software development company and am writing a user's
> manual for a new product which includes the standard Windows editing
> functions of Cut, Paste, Copy, Undo and Select All. The product is
> targeted for a specialized, professional market, and it is expected
> that users will already be comfortable with Windows software. This
> being the case, should I document the standard Windows editing
> functions, or is it reasonable to assume that they will be
> understood? All input on this question most welcomed.
The last company I worked for wanted all of these commands documented,
since a customer could use them. The company I currently work for
doesn't need them documented, because they aren't part of the "real"
product. The Windows commands used by the customers as part of the
software are documented, briefly.
If you don't document these commands, you should at minimum refer the
user to Windows help.
Joanne Grey Senior Technical Writer
j -dot- grey -at- worldnet -dot- att -dot- net #include disclaimers.h
joann -at- genesyslab -dot- com http://www.genesyslab.com
"Creativity is allowing yourself to make mistakes. Art is
knowing which ones to keep."