Developmental Editing Checklist
Structure and Organization
- Audience definition, purpose of document, and how to use the book are clear.
- Information is appropriately presented for the audience.
- Concepts flow logically.
- Superfluous or redundant material is eliminated.
- Heads are useful, descriptive, and specific.
- Information is easy to find.
- Information is task-oriented where appropriate.
- Reference and conceptual information are eliminated from task descriptions.
- Distinctions between parts and chapters are clear.
- Reader context is established and reinforced.
- Tone is appropriate for the reader and to the focus of the book.
- Critical information is covered clearly.
- Task-oriented writing is clear; user actions and system actions are distinct.
- Assumptions are clearly supported.
- Writing and layout are optimized for on-line presentation.
- Terms are used consistently and appropriately.
- Terms are defined and used in context correctly.
- Terms and abbreviations avoid jargon and follow guidelines for localization.
- Documentation set conventions are established and followed.
Formatting and Layout
- Book conforms to company publications standards.
- Standard templates and formats are used.
- Graphics appear where needed.
- Artwork is integrated within the text.
- Tables, figures, and illustrations are used effectively and appropriately.
- Illustrations follow artwork and localization guidelines.
- New graphics or presentation techniques are identified and used effectively.
- Innovations meet company design standards.