jool's techwriting notes & resources
Example outline for API
Front Matter
-title (page 1)
-author, credits, and copyright info (page 2)
About this guide
define product and goal of guide
- Audience for this guide
- How to use this guide
- What this guide contains (chapter links with description)
- Recommended background reading
- Conventions used in this guide
Part One: Getting started
Chapter 1: Product overview
Chapter 2: Getting started (the basics on all steps involved in using
product)
Part Two: Using the API
Chapter 1: Describe methods grouped by usage 1
Chapter 2: Describe methods grouped by usage 2
(depending on size of API, might need a part devoted to each
"usage" class, and each chapter devoted to
subset)
Part Three: Utilities and troubleshooting
Part Four: Reference (Appendices)
Part Five: Glossary