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.
It might sometimes be difficult to know where to draw the line between
"Required reading" and "Supplementary Information", because it depends on
the individual user and the particular situation.
But I'm glad that most respondents felt that Troubleshooting should be a
chapter - I'm inclined to agree.
Thanks again.
Gilda Spitz
Manager, Documentation
Longview Solutions Inc.
---------------------- Forwarded by Gilda Spitz/Admin/Longview Solutions
Inc. on 11/27/2000 12:47 PM ---------------------------
Gilda Spitz
11/24/2000 03:57 PM
To: techwr-l -at- lists -dot- raycomm -dot- com
cc:
Subject: "Chapter" vs "Appendix"
I searched the archives, but didn't find anything on this topic.
At the moment, most of the books in our documentation suite contain several
chapters, and at least one appendix. But I'm now starting to question
whether it's necessary to make the distinction.
When I first set up our templates, I decided that Troubleshooting should be
in an appendix, rather than a chapter. I also created an appendix for
additional information that was helpful, but not directly a description of
the tasks in the software. But what's the difference? As long as each
grouping of information is presented in its own chapter, isn't that
distinct enough?
I'm curious - what do other people do?
Gilda Spitz
Manager, Documentation
Longview Solutions Inc.
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Develop HTML-based Help with Macromedia Dreamweaver! (STC Discount.)
**NEW DATE/LOCATION!** January 16-17, 2001, New York, NY. http://www.weisner.com/training/dreamweaver_help.htm or 800-646-9989.
Sponsored by SOLUTIONS, Conferences and Seminars for Communicators
Publications Management Clinic, TECH*COMM 2001 Conference, and more http://www.SolutionsEvents.com or 800-448-4230
---
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.
