Sahi Pro - Sahi as a Documentation Tool


abstract Sahi can be used to create simple documentation with screenshots.
Manual testers can use this as a tool to create a knowledge base for other manual or automation testers.
The recorded document contains the script, plus links to screenshots.
It can be run as a normal sahi script too, thus helping automation testers quickly see what needs to be done.

Recording in Documentation Mode


To record in documentation mode, check the "Enable Screenshot. Used for Documentation" checkbox before clicking "Record".

Viewing and Editing Document


Open the Script Editor for the particular script

Notice how the script has comments with documentation information
/**
 *<screenshot>demo_doc.sah_images/demo_doc.sah_setValue__textbox__user_____test___0.png</screenshot>
 *<description></description>
 */
_setValue(_textbox("user"), "test");

Click on the Docs button to show the script as a html document with screenshots
  1. Load the script to view as Documentation
  2. The screenshot
  3. The script step in a readonly textbox
  4. The English version of the step. This can be edited and saved
  5. Delete Image button lets us delete images which are not very useful to the documentation
  6. Save comments saves modifications to comments and images.
  7. Enter a folder/directory path and click Export as HTML to export relevant images and HTML files to the specified folder.