Document Layout Checklist

Home Page
The Author
Instructor.Resources
Student.Resources
Programs

iChat
Message Board
Buy the Book

 

Document Layout Checklist

Overall

q     Has the client, sponsor, and/or user reviewed your selection of page or screen design?

q     Do all of the elements of your manual or online help set contain parallel information for consistency and efficiency?

Layout Goals

q     Include elements to help the user overcome the documentation problem.

q     Include support for overall task orientation.

q     Accommodate the user’s visual needs.

Modularity

q     Repeat background information where necessary

q     Repeat screens where necessary.

q     Include orientation information about the relationship of a task to other tasks.

q     Keep all relevant steps on the same page.

q     Minimize cross references.

Structure

q     Rules

q     Bullets

q     White/quiet space

q     Chunks

Page and Screen Designs

Page:

Screen:

q     Two-column format

q     Windows help format

q     One-column format

q     Man-page format

q     Multiple-column format

 

 

Determine the following layout elements:

Page:    Screen:

Page:

Screen:

q     Left margin

q     Sizing and scrolling

q     Columns

q     Multiple window management

q     Headers and footers

q     Cuing and highlighting

q     Icons and diagrams

q     Icons and buttons

q     Screens

q     Margins and columns

q     Rules

q     Line spacing

q     Pagination

 

Determine the Following Text Elements

 

 

Size

Style

Font

Body Text

 

 

 

Headings

 

 

 

Hints

 

 

 

Notes

 

 

 

Cautions

 

 

 

Warnings

 

 

 

User input

 

 

 

Computer output

 

 

 

Tables

 

 

 

Lists

 

 

 

This page maintained by Thomas Barker thomas.barker@ttu.edu  Hit Counter  Copyright © 2003 Pearson Education, publishing as Longman Publishers  Legal Notice