Re: chapter numbering

Subject: Re: chapter numbering
From: Alexia Prendergast <alexiap -at- SEAGATESOFTWARE -dot- COM>
Date: Tue, 14 Oct 1997 17:11:31 -0400

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


Previous by Author: Re: Post-its for Online Reviewing
Next by Author: Re: Info request on teaching TW (long)
Previous by Thread: Re: chapter numbering
Next by Thread: Re: Chapter Numbering


What this post helpful? Share it with friends and colleagues:


Sponsored Ads