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.
Buck, we are of one mind (hopefully yours -- I'm questioning the
soundness of mine at the moment ;-)
The only things we do differently is that we put our installation stuff
in a separate small guide,
appendices are for reference info (database table schema, etc.), and the
glossary is second to last, just before the index. Simple formula that
works well for us.
A.
--
Alexia Prendergast
Tech Pubs Manager
Seagate Software (Durham, NC, USA) mailto:alexiap -at- seagatesoftware -dot- com
> -----Original Message-----
> From: Buck & Tilly Buchanan [SMTP:writer -at- wf -dot- net]
> Sent: Tuesday, October 14, 1997 4:59 PM
> To: TECHWR-L -at- LISTSERV -dot- OKSTATE -dot- EDU
> Subject: Re: chapter numbering
>
> Mike
>
> Not a hard-and-fast rule, but:
>
> Front Matter: Things about the company and about the book (numbered
> i,
> ii, iii, etc.)
>
> Chapter 1: Things about the program (Introduction stuff)
>
> Chapter 2-x: How-to. Including "see Appendix A for
> installation/setup
> instructions.
>
> Appendix A: Installation. Why? If it's a Windows application,
> Run
> setup.exe is so well-known that most folks don't care to read about it
> again. Put it at the back of the book so they don't have to look at
> it.
>
> Appendix B-x: Glossary, etc. other stuff for newbies or unusual
> information.
>
> Bibliography if...
>
> Index
>
>
> --
>
>
> Buck Buchanan
> writer -at- wf -dot- net
> Sunset, TX
>
> ~~
> TECHWR-L (Technical Communication) List Information: To send a
> message
> to 2500+ readers, e-mail to TECHWR-L -at- LISTSERV -dot- OKSTATE -dot- EDU -dot- Send
> commands
> to LISTSERV -at- LISTSERV -dot- OKSTATE -dot- EDU (e.g. HELP or SIGNOFF TECHWR-L).
> Search the archives at http://www.documentation.com/ or search and
> browse the archives at
>http://listserv.okstate.edu/archives/techwr-l.html
> Send list questions or problems to the listowner at
TECHWR-L (Technical Communication) List Information: To send a message
to 2500+ readers, e-mail to TECHWR-L -at- LISTSERV -dot- OKSTATE -dot- EDU -dot- Send commands
to LISTSERV -at- LISTSERV -dot- OKSTATE -dot- EDU (e.g. HELP or SIGNOFF TECHWR-L).
Search the archives at http://www.documentation.com/ or search and
browse the archives at http://listserv.okstate.edu/archives/techwr-l.html