cheatsheettype

Return to HomePage

Summary

Cheat Sheets provide a quick reference.

Schema

* Title
* Applies To
* Summary
* Contents
* Objectives
* Overview
* Body
* Additional Resources
* Feedback
* Technical Support
* 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 describe the usage of the module?
* Does the summary explain why it is important to understand the details contained in the explained?
* Does the summary pass the ‘hallway test’ – would this be your verbal description of the module’s purpose?

Contents
* Is each major heading listed?
Objectives
* Are the most important learnings from the document extracted into the objectives?
* Is each objective expressed as a specific task?
* Is the objectives list short enough that it can be easily scanned and understood?

Overview
* Does the overview provide enough background information to understand why it is necessary to take the steps?
* Does the overview provide enough information that the module can stand alone?
* Does the overview explain the topography and flow of the document with enough context that the reader can choose what sections to read?

Body
* Does each section start with an explanation of why the information is useful?
* When there are choices to make are they prefaced with ‘if…’ to explain the context?
* Are the topics organized so that a reader could use table of contents to easily drill into an area of interest?
* Can each top-level topic stand alone or is it necessary to read the entire document?

Additional Resources
* For each link, do you know why the link is included without first following the link?

Feedback
* Is there a way to provide feedback?
Technical Support
* Is there a way to contact technical support?
Community and Newsgroup
* Is there a list of community sites?

Contributors and Reviewers

Return to HomePage

Summary

Schema

Test Cases

Example

Template

Links