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.
I include a preface in one software manual that precedes the TOC. The
preface discusses software support and conventions of the book, but is not
about the use of the software product. Use of the software product is
discussed in the chapters and appendices that follow the TOC. The preface is
numbered using Roman numerals.
The Preface and it's headings are included in the TOC, and the Index refers
to items in the preface, also.
Is including such a preface before the TOC appropriate? Ought I move the
preface and it's contents into the body of the book, thus creating a regular
chapter?
My Reply:
I think that's probably the best place for it, personally. In fact, I've
seen many other manuals organized this way and have come to expect it. For
those familiar with your products, it puts it in a relatively out-of-the-way
place that's still readily accessible for those not familiar or who need
refreshing. I don't think I've seen many other manuals that included such
information in the index, which I think is also a good idea.
Sam Beard
Technical Writer
GSC, GTE (soon to be Bell Atlantic-GTE, soon to be something else entirely!)
