Return to HomePage



Summary

Presents the essential information in a quick view.




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




Examples

* At a Glance: Web Application Threat Model: http://msdn.microsoft.com/library/en-us/dnpag2/html/TMWAglance.asp
* At a Glance: Building Secure ASP.NET Applications: http://msdn.microsoft.com/library/en-us/dnnetsec/html/SecNetglance.asp




Template

* At a Glance Template




Key Information

Description
* Presents the essential information in a quick view.
Purpose
* Consolidate and express information succinctly

Use Cases
* Present a summary view of the topic

Relationship to Other Guidance Types
* Summarizes more detailed information from other module types




Links

* At a Glance Template
* At a Glance Examples



Return to HomePage
Microsoft Communities