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:To Preface or Not To Preface From:David Dubin <David_Dubin -at- NOTES -dot- PW -dot- COM> Date:Mon, 13 Jun 1994 14:30:57 PDT
Another question of my fellow writers. How do you begin written
documentation? Traditionally, we have used a preface which contained the
purpose and scope of the manual, an explanation of each section, and
concluded with the document conventions and related documentation (if any).
I have been told that this practice is becoming passe. Indeed, in a survey of
several user's manuals from folks like Microsoft and WordPerfect, I found no
Preface, but rather a Getting Started or About This Guide section preceding
the first chapter.
Appreciate any thoughts from y'all on this. Thanks in advance.
David Dubin -at- pw -dot- notes -dot- com
--------------------------------------------------------------------------------
-------
"Freedom is not free, it is paid for in the blood of our children."
