Table of Contents and Introductions ITSW 1410, Presentation Media Software Instructor: Glenda H. Easter

Make Your Table of Contents Outline the Material  Include chapter titles and the first level headings from each chapter.  Most readers will check a chapter of a manual only once, but they look at the table of contents dozens of times.  Give your audience an idea of what’s in each chapter.  First level headings should target beginners.

Good Table of Contents...  Use verbs rather than nouns because they suggest action.  Don’t ask too many questions.  Use simple layouts.  Include both upper and lower case.  Does not preface chapter headings with a string of numbers. Example: A  Generally, do not include chapter table of contents.

Show Your Audience How to Use the Documentation  Use your audience profile to route users to information pertaining to their level of expertise.  Make access routes clear.

Tell Your Audience What They Need to Get Started 4 Don’t allow your users to become frustrated, tell them what they need to get started. 4 A packing list of box contents in your first booklet is helpful, if not provided by the manufacturer.

Tell Your Audience What They Need to Get Started 4 List what’s included in the product package. 4 Tell people what to do such as making backups. 4 People should write the Introduction last because they know the product best by then.

Introduce Major Topics  Provide overviews to establish context 4 “By now, you should know by know...” 4 “In this chapter, you will learn...” 4 Tell the user what the chapter does and does not discuss.

A Few More Tips  Tell each user where they can find material in the manual.  Tell experienced users what they can skip.  Give page numbers for related subjects.  Don’t duplicate material that is presented elsewhere.  Don’t use the overview use a means of introducing exceptions.

Tell Audience What the Product Can Do For Them 4 Let audience know how using the package can increase their productivity. 4 Include a quick overview of how the product works. 4 Tell your audience about custom/standard installations.