Doc Tutorial


In this tutorial we will talk about the DOC feature which automatically generates Test Documentation out of test scripts. To use the DOC component, just click on the DOC button at the left toolbar. Test Documentation consists from steps, where each step can have a name, a description and an expected result. This is a common format for test documentation. At the top is a toolbar for text formatting. With it we could apply different styles, font settings and alignments to the step’s text. Use the buttons on the left to add, move, or delete steps. For example we can add a step above the first, move it forward and then remove it. To remove all steps, use the “Clear Documentation” command in the menu. The main advantage of the DOC component is the automatic conversion of the “test script” to “test documentation”. To begin, make sure you have a Test Script opened in the 1Script component so we can generate Test Documentation for it, then click on the “Generate From Script” button on the toolbar and ZAPTEST will automatically create documentation steps. Each line of the script is converted to plain english text. We can now easily edit the content of each documentation step. Furthermore, if we change the script, we can re-generate the documentation and ZAPTEST will insert new items in appropriate positions. For example, let’s add a new line to our script and then open the DOC component and add some text data to the first Step. Now, when we click “Generate From Script” button one more time, ZAPTEST will ask us about each modification and insert the new Step to the documentation. When done editing, we can export the documentation to HTML or RTF file formats, or to the integrated test management tools: HP ALM or CA Agile Central. Let’s export this test documentation to HTML formatted file. Click on “Export to HTML” button and select the output path. Open the the exported file. The HTML file contains the formatted table with the Test Documentation. RTF Documents will also contain the table and the text styles. Next, let’s export to CA Agile Central and HP ALM Servers. Click “Export to HP ALM” button and save the documentation as a new test case under the HP ALM project. We can see that ZAPTEST exported all steps and also kept text styles. Let’s check how CA Agile Central works. Click “Export to CA Agile Central” button and save as new test case document. On the CA Agile Central we will get all of the documentation steps as expected. Thank you for using ZAPTEST!

Contact Us

Tower Place 100

3340 Peachtree Rd NE #1800 

Atlanta, GA 30326 USA

(404) 814-5227