Guideline Item Template Test Cases

Title
  • Does the title clearly state the action to take?
  • Does the title start with an action word (eg. Do something, Avoid something)?

Applies To
  • Do you list technology and version? (e.g. ASP.NET 2.0)

What to Do
  • Do you state the action to take?
  • Do you avoid stating more than the action to take?

Why
  • Do you provide enough information for the user to make a decision?
  • Do you state the negative consequences of not following this guideline?

When
  • Do you state when the guideline is applicable?
  • Do you state when not to use this guideline?

How
  • Do you state enough information to take action?
  • Do you provide explicit steps that are repeatable?

Problem Example
  • Do you show a real world example of the problem from experience?
  • If there are variations of the problem, do you show the most common?
  • If this is an implementation guideline, do you show code?

Solution Example
  • Does the example show the resulting solution if the problem example is fixed?
  • If this is a design guideline is the example illustrated with images and text?
  • If this is an implementation guideline is the example in code?

Additional Resources
  • Are the links from trusted sites?
  • Are the links correct in context of the guideline?

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

Additional Tests to Consider When Writing a Guideline
  • Does the title clearly state the action to take?
  • Does the title start with an action word (eg. Do something, Avoid something)?

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

Comments

No comments yet.