Here is a checklist for having well-documented test cases:
Quality Attributes
- Accurate - tests what the description says it will test.
- Economical - has only the steps needed for its purpose
- Repeatable, self standing - same results no matter who tests it.
- Appropriate - for both immediate and future testers
- Traceable - to a requirement
- Self cleaning - returns the test environment to clean state
Structure and testability
- Has a name and number
- Has a stated purpose that includes what requirement is being tested
- Has a description of the method of testing
- Specifies setup information - environment, data, prerequisite tests, security access
- Has actions and expected results
- States if any proofs, such as reports or screen grabs, need to be saved
- Leaves the testing environment clean
- Uses active case language
- Does not exceed 15 steps
- Matrix does not take longer than 20 minutes to test
- Automated script. is commented with purpose, inputs, expected results
- Setup offers alternative to prerequisite tests, if possible
- Is in correct business scenario order with other tests
Configuration management
- Employs naming and numbering conventions
- Saved in specified formats, file types
- Is versioned to match software under test
- Includes test objects needed by the case, such as databases
- Stored as read
- Stored with controlled access
- Stored where network backup operates
- Archived off-site