How To Template Test Cases

Use the following questions to guide you when reviewing or creating a How To.

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?
  • Does the title effectively convey what the how to is addressing?

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?

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?

Summary of Steps
  • Will the set of steps listed solve the problem?

Step <<N>>
  • Does each step explain what to do, why it is important and then how to take action?
  • If there is a decision point is it called out with an explicit ‘if…’ condition?
  • Is the How To capable of standing alone without requiring the user to search elsewhere to complete the solution?
  • Where appropriate, are there code or configuration file examples?

Considerations <<Name>>
  • Are the consequences of applying this How To considered?
  • Are potential solutions to these consequences outlined?
  • Has testing, security, performance, reliability and operations been considered?

Additional Resources
  • For each link, do you know why the link is included without first following the link?
  • Are the links from trusted sites?
  • Are the links correct in context of the How to?

Related Items
  • Are the correct items linked in context of the How to?

Last edited Apr 1, 2007 at 12:13 AM by mycodeplexuser, version 1

Comments

No comments yet.