Providing services in instructional design, virtual training, and human performance improvement.

Monday, September 15, 2014

Developing Templates: Style Guides

Developing a style guide (sometimes called a stylebook) is one of the most important support documents we create and maintain within a project. By creating a strong style guide prior to design and development, you set expectations and standards for the project. This means you avoid costly time spent going back to make revisions and corrections across a sloppy or inconsistent product.

In essence, a style guide sets the standard for the writing and design of a document or other deliverable. Style guides vary from company to company, but here are some basic categories to consider including:
  • Accommodation requirements (American Disabilities Act, Section 508 Compliance)
  • Document and asset repositories (file locations, shared sites)
  • Editorial
    • Capitalization
    • Grammar
    • Punctuation
    • Spelling
  • Formatting and style
    • Assessment format (question types and format)
    • Fonts and colors
    • Storyboard/Screen layout conventions
    • Text formatting
    • Titles and subtitles
  • Media conventions (audio, image, video)
  • Naming conventions
The style guide categories will vary depending on the format of your deliverable. A basic text document may only need editorial and formatting conventions. A web-based training, however, may need conventions for screen layouts, media use, and other product specific considerations.

If you are creating a style guide for the first time, keep in mind that you don’t have to start from scratch. You may be able to start from a corporate style or marketing guide that addresses items commonly encountered in that particular company.

With regards to spelling, grammar, and punctuation, you can also consult a published stylebook as a secondary guideline. Some popular stylebook options are:
  • Chicago Manual of Style (preferred in book publishing)
  • Associate Press Stylebook or AP (preferred in magazine and newspaper writing)
  • Publication Manual of the American Psychological Association or APA (preferred in academic
From these resources, client needs, and your own best practices, you can create a strong template to ensure consistency and professionalism across your projects.

No comments:

Post a Comment