Object Oriented Software Engineering   View all facts   Glossary   Help
subject > problem > defect > documentation defect
Next defecthung system    Updefect    Previous defectdefect in handling stress and unusual situations   

documentation defect
subjectfact 
documentation defecthas definition A defect in a user manual, reference manual or on-line help that gives incorrect information or fails to give information relevant to a problem2001-08-30 14:55:22.0
has testing strategy
  • Examine all the end-user documentation (in both paper and on-line forms), making sure it is correct
  • Make sure it has correct solutions to problems that users might encounter, and correct instructions to help beginners learn how to use the software
  • Work through the use cases, making sure that each of then is adequately explained to the user
2001-08-30 14:55:22.0
is a subtopic of 10.7 - Documentation Defects2001-08-30 14:55:22.0
is a kind of defect2001-08-30 14:55:22.0
defecthas example the absence of code to handle an exception2001-08-30 14:55:12.0
problemhas solution which will normally entail developing software, although you may decide that it is better to purchase software or to develop a non-software solution2001-08-30 14:57:03.0
should be written as a simple problem statement in one or two sentences2001-08-30 14:57:03.0