Modular Web Design: Creating Reusable Components for User Experience Design and Documentation

Chapter 13. Guide

Library users must understand what’s in the library, why it exists, and how to use it. Library documentation shows your team how to use your valuable investment.

This chapter will teach you how to do the following:

• Use Web site documentation as a hub for library activity and knowledge.

• Publish component references and getting-started documents that go beyond your typical style guide.

• Embed instructions and details into component artwork.

• Use design patterns as a foundation for writing about components.

• Devise a set of components attributes that works best for you.

• Know when to author—and not author—visual specs.

Documenting a Library

The library’s reach and effectiveness can be extended significantly by the quality of its documentation. ...