Difference between revisions of "INADEQUATE DOCUMENTATION"

From Test Automation Patterns
Jump to navigation Jump to search
m (Topic titles in capital letters)
 
(One intermediate revision by the same user not shown)
Line 1: Line 1:
 
<div id="content_view" class="wiki" style="display: block"><span style="font-size: 14px">................................................................................................................[[Main Page]] / Back to [[Process Issues]] / Back to [[Test Automation Issues]]</span>
 
<div id="content_view" class="wiki" style="display: block"><span style="font-size: 14px">................................................................................................................[[Main Page]] / Back to [[Process Issues]] / Back to [[Test Automation Issues]]</span>
 
=<span style="font-family: Arial; font-size: 16px">'''Issue Summary'''</span>=
 
=<span style="font-family: Arial; font-size: 16px">'''Issue Summary'''</span>=
<br /> <span style="font-size: 16px">Test automation testware (scripts data etc.) are not adequately documented</span>
+
<span style="font-size: 16px">Test automation testware (scripts data etc.) are not adequately documented</span>
 
=<span style="font-size: 16px">'''Category'''</span>=
 
=<span style="font-size: 16px">'''Category'''</span>=
<br /> <span style="font-size: 16px">Process</span><br /> <br />  
+
<span style="font-size: 16px">Process</span>  
 
=<span style="font-family: Arial; font-size: 16px">'''Examples'''</span>=
 
=<span style="font-family: Arial; font-size: 16px">'''Examples'''</span>=
<br /> <span style="font-size: 16px">Test scripts are not documented at all or not adequately, so they cannot be found (no reuse) or nobody knows what they actually do.</span><br /> <span style="font-size: 16px">Available data is not documented so it cannot be reused. </span><br /> <span style="font-size: 16px">Documentation is missing about the kind of data and / or where to find it or where to store it.</span><br /> <span style="font-size: 16px">There is no overview of the automation "regime" - where various artefacts are stored, the aims and objectives of the automation, etc.</span><br /> <br />  
+
<span style="font-size: 16px">Test scripts are not documented at all or not adequately, so they cannot be found (no reuse) or nobody knows what they actually do.</span><br /> <span style="font-size: 16px">Available data is not documented so it cannot be reused. </span><br /> <span style="font-size: 16px">Documentation is missing about the kind of data and / or where to find it or where to store it.</span><br /> <span style="font-size: 16px">There is no overview of the automation "regime" - where various artefacts are stored, the aims and objectives of the automation, etc.</span>  
 
=<span style="font-family: Arial; font-size: 16px">'''Questions'''</span>=
 
=<span style="font-family: Arial; font-size: 16px">'''Questions'''</span>=
<br /> <span style="font-size: 16px">Who creates the scripts? Who maintains them?</span><br /> <span style="font-size: 16px">Who creates the data? Who maintains it?</span><br /> <span style="font-size: 16px">Who uses the data or the scripts?</span><br /> <span style="font-size: 16px">Are there standards? Are they used?</span>
+
<span style="font-size: 16px">Who creates the scripts? Who maintains them?</span><br /> <span style="font-size: 16px">Who creates the data? Who maintains it?</span><br /> <span style="font-size: 16px">Who uses the data or the scripts?</span><br /> <span style="font-size: 16px">Are there standards? Are they used?</span>
 
=<span style="font-family: Arial; font-size: 16px">'''Resolving Patterns'''</span>=
 
=<span style="font-family: Arial; font-size: 16px">'''Resolving Patterns'''</span>=
<br /> <span style="font-family: Arial; font-size: 16px">Most recommended:</span><br />  
+
<span style="font-family: Arial; font-size: 16px">Most recommended:</span><br />  
 
+
* <span style="font-size: 16px">[[DOCUMENT THE TESTWARE]]: Document the automation scripts and the test data</span>
* <span style="font-size: 16px">[[DOCUMENT THE TESTWARE]]</span>
+
* <span style="font-size: 16px">[[DESIGN FOR REUSE]]: Design reusable testware</span>
* <span style="font-size: 16px">[[DESIGN FOR REUSE]]</span>
 
 
<br /> <span style="font-size: 16px">Other useful patterns:</span><br />  
 
<br /> <span style="font-size: 16px">Other useful patterns:</span><br />  
 
+
* <span style="font-size: 16px">[[SET STANDARDS]]: Set and follow standards for the automation artefacts</span>
* <span style="font-size: 16px">[[SET STANDARDS]]</span>
 
 
<br /> <span style="font-size: 14px">................................................................................................................[[Main Page]] / Back to [[Process Issues]] / Back to [[Test Automation Issues]]</span></div>
 
<br /> <span style="font-size: 14px">................................................................................................................[[Main Page]] / Back to [[Process Issues]] / Back to [[Test Automation Issues]]</span></div>

Latest revision as of 17:02, 26 June 2018

................................................................................................................Main Page / Back to Process Issues / Back to Test Automation Issues

Issue Summary

Test automation testware (scripts data etc.) are not adequately documented

Category

Process

Examples

Test scripts are not documented at all or not adequately, so they cannot be found (no reuse) or nobody knows what they actually do.
Available data is not documented so it cannot be reused.
Documentation is missing about the kind of data and / or where to find it or where to store it.
There is no overview of the automation "regime" - where various artefacts are stored, the aims and objectives of the automation, etc.

Questions

Who creates the scripts? Who maintains them?
Who creates the data? Who maintains it?
Who uses the data or the scripts?
Are there standards? Are they used?

Resolving Patterns

Most recommended:


Other useful patterns:

  • SET STANDARDS: Set and follow standards for the automation artefacts

................................................................................................................Main Page / Back to Process Issues / Back to Test Automation Issues