kelly vincent and robert farrell 4/576 online documentation april 9, 2011
TRANSCRIPT
![Page 1: Kelly Vincent and Robert Farrell 4/576 Online Documentation April 9, 2011](https://reader035.vdocuments.us/reader035/viewer/2022081822/5697c0151a28abf838cce117/html5/thumbnails/1.jpg)
Writing Software DocumentationA Task- Oriented ApproachChapter 14 – Designing Indexes
Kelly Vincent and Robert Farrell4/576 Online DocumentationApril 9, 2011
![Page 2: Kelly Vincent and Robert Farrell 4/576 Online Documentation April 9, 2011](https://reader035.vdocuments.us/reader035/viewer/2022081822/5697c0151a28abf838cce117/html5/thumbnails/2.jpg)
Designing Indexes
Good general overview Plan Your Indexing Strategy▪ Review the User Analysis▪ Mark the Index Entries▪ Build the Index▪ Edit the Index
![Page 3: Kelly Vincent and Robert Farrell 4/576 Online Documentation April 9, 2011](https://reader035.vdocuments.us/reader035/viewer/2022081822/5697c0151a28abf838cce117/html5/thumbnails/3.jpg)
Designing Indexes
Decide What to Index Commands and Functions Concepts User Terms and Questions Glossary Terms Proper Names of Products and
Companies Tasks and Procedures
![Page 4: Kelly Vincent and Robert Farrell 4/576 Online Documentation April 9, 2011](https://reader035.vdocuments.us/reader035/viewer/2022081822/5697c0151a28abf838cce117/html5/thumbnails/4.jpg)
Designing Indexes
Identify the Level of Detail Mirror the Chicago Manual of Style for
Indexes Decide on Phrasing and Format
Above all, be consistent Criticism▪ No definition of alphabetization▪ Inconsistent use within the text examples
![Page 5: Kelly Vincent and Robert Farrell 4/576 Online Documentation April 9, 2011](https://reader035.vdocuments.us/reader035/viewer/2022081822/5697c0151a28abf838cce117/html5/thumbnails/5.jpg)
Designing Indexes
Edit and Proofread Editing an index is a daunting task▪ Have someone else look at it
Criticism▪ Does an automatic indexing program have
the same intuition as a human?▪ Are the online indexing sights listed still in
existence?▪ Interesting that Barker talks about profession
indexers
![Page 6: Kelly Vincent and Robert Farrell 4/576 Online Documentation April 9, 2011](https://reader035.vdocuments.us/reader035/viewer/2022081822/5697c0151a28abf838cce117/html5/thumbnails/6.jpg)
Designing Indexes
Why do we need indexes? More in-depth than a Table of Contents Alternative way to find specific
information
![Page 7: Kelly Vincent and Robert Farrell 4/576 Online Documentation April 9, 2011](https://reader035.vdocuments.us/reader035/viewer/2022081822/5697c0151a28abf838cce117/html5/thumbnails/7.jpg)
Designing Indexes
What Now? Print versus online versus keywords▪ Each is too different. They cannot be
compared▪ Each is specific for the method of information
delivery they are designed for▪ A product of their time
![Page 8: Kelly Vincent and Robert Farrell 4/576 Online Documentation April 9, 2011](https://reader035.vdocuments.us/reader035/viewer/2022081822/5697c0151a28abf838cce117/html5/thumbnails/8.jpg)
Designing Indexes
The EndHave a Nice Weekend