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.
Greetings all,
A question came up regarding the order of front matter in our documents.
Specifically, the current, listed order of the following components:
Content at a Glance ==>> High-level, brief overview of what the chapters
contain, no page numbers
Revision History ==>> Self explanatory
(list of) Tables ==>> numbered
(table of) Figures ==>> numbered
(list of) Matrices ==>> if needed in the document; numbered
(table of) Content ==>> numbered, of course
The question/remark/opinion that came from one of our SMEs, inferred that
the order should be:
Revision History
(table of) Content
then, whatever order I choose for the last three...
(list of) Tables
(table of) Figures
(list of) Matrices
I've looked through Merriam-Webster's Manual and other resources.
They indicate that there is no preferred order for these components.
My question: What are your preferences (if any) regarding the order of these
components?
Follow-up question: How do you set up the front matter in your documents?
Currently, I start with the preface; containing the components as listed
above.
Then the introduction, with information about who/how/why to use the
document:
Oversight and Compliance
Who Should Read this Guide
Formatting Conventions Used in this Guide
Additional Documents in this (specific) Suite
Please feel free to e-mail me privately or through the group. All comments,
suggestions, remarks,
and information will be sifted and posted, if requested.
Thank you,
Frank
Francis J. Krasovic
Manual Laborer / DocDept Manager
IntelliNet Technologies
[mailto:krasovic -at- intellinet-tech -dot- com]
+321.726.0686
---------------------------------------------
Homines dum docent discunt
Even while they teach, men learn.
---------------------------------------------
*** Deva(tm) Tools for Dreamweaver and Deva(tm) Search ***
Build Contents, Indexes, and Search for Web Sites and Help Systems
Available now at http://www.devahelp.com or info -at- devahelp -dot- com
A landmark hotel, one of America's most beautiful cities, and
three and a half days of immersion in the state of the art:
IPCC 01, Oct. 24-27 in Santa Fe. http://ieeepcs.org/2001/
---
You are currently subscribed to techwr-l as: archive -at- raycomm -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- raycomm -dot- com
Send administrative questions to ejray -at- raycomm -dot- com -dot- Visit http://www.raycomm.com/techwhirl/ for more resources and info.
