Re: Help file TOC Sentence VS Question

[Robert Lauriston <robert -at- lauriston -dot- com>]

For introductory material, I prefer "Understanding," "Introducing," or
"Overview" to "About," since the following topics will all be about
the same general subject.

My typical TOC for a software product looks like this:

Welcome to <product>	
	System Requirements and Database Support
	About This Document
	Additional <product> Documentation and Resources
	Technical Support
<product> Overview
	The <product> Development Process [or whatever you'd call its workflow]
	Elements of a <product> Project
		e.g. File
		e.g. Elements in a File
		etc.
	<product> Architecture, Components, and Utilities
Using <product>
	Working with Files
		Creating Files
			Create a New, Blank File
			Create a File from a Template
	Adding and Working with <elements>
		Understanding <elements> [if it's not self-explanatory]
...
Administrator's Guide
...
Customizing and Automating <product>
...
Tutorials
Reference
Glossary



On Wed, Oct 28, 2009 at 1:43 PM, John Garison <john -at- garisons -dot- com> wrote:
> TOCs are one thing, indexes another.
>
> In terms of general information structure, I like to have an overarching
> topic: "About Timecards" ...
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Free Software Documentation Project Web Cast: Covers developing Table of
Contents, Context IDs, and Index, as well as Doc-To-Help  
2009 tips, tricks, and best practices.
http://www.doctohelp.com/SuperPages/Webcasts/

Help & Manual 5: The complete help authoring tool for individual
authors and teams. Professional power, intuitive interface. Write
once, publish to 8 formats. Multi-user authoring and version control! http://www.helpandmanual.com/

---
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot- 

To unsubscribe send a blank email to 
techwr-l-unsubscribe -at- lists -dot- techwr-l -dot- com
or visit http://lists.techwr-l.com/mailman/options/techwr-l/archive%40web.techwr-l.com


To subscribe, send a blank email to techwr-l-join -at- lists -dot- techwr-l -dot- com

Send administrative questions to admin -at- techwr-l -dot- com -dot-  Visit
http://www.techwr-l.com/ for more resources and info. 

Please move off-topic discussions to the Chat list, at:
http://lists.techwr-l.com/mailman/listinfo/techwr-l-chat