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: Two Techwriting Issues From:Jane Torpie <Jane_Torpie_at_III-HQ -at- RELAY -dot- PROTEON -dot- COM> Date:Fri, 17 Dec 1993 13:10:00 EST
Matthew -
These are quick responses; please ask if you'd like more detail.
1. A tutorial works well w/ 2nd person. A user manual is the next step on
a continuum, so that's debatable. A reference guide is yet another step
... by then, I usually prefer 3rd person if possible. Either way, avoid a
lot of "you".
2. For FrameMaker help, I understand (from the Frame Technology people)
that if you want to use the help that Frame generates, it's necessary to
buy their API so your developers can program the right hooks into the
product code.
_______________________________________________________________________
Jane Torpie
Senior Technical Writer
Easel Corporation
Burlington, MA
Jane_Torpie_at_III-HQ
