At a Glance

Summary

Presents the essential information in a quick view.

Examples


Schema

  • Title
  • Applies To
  • Summary
  • Contents
  • Body
  • Additional Resources
  • Feedback
  • Community and Newsgroup
  • Contributors and Reviewers


Test Cases

Title
  • Does the title distinguish by product or version where possible?
  • Are important nouns a user might scan for towards the left of the title?

Applies To
  • Is it clear what technologies or products this applies to?
  • Conversely, is it clear what technologies of products this does not apply to?
Summary
  • Does the summary pass the ‘hallway test’ – would this be your verbal description the module’s purpose?
  • Is the summary short and to the point?
Contents
  • Is each major heading listed?
Body
  • Does the At a Glance summarize the key concepts of the underlying document?
  • Is the At a Glance too long to be a good summary?
  • Does the At a Glance dive into details that are best left in the underlying document?
Additional Resources
  • Is a link back to the appropriate index included?
  • Is a link to the document this At a Glance is summarizing included?
  • For each link, do you know why the link is included without first following the link?
Feedback
  • Is there a way to provide feedback?
Community and Newsgroup
  • Is there a list of community sites?
Contributors and Reviewers

Last edited Apr 7, 2010 at 10:02 PM by paulenfield, version 2

Comments

No comments yet.