Forum Discussion

richv's avatar
richv
Occasional Contributor
13 years ago

How do I document my test script

I have been working with a contractor who has produced a number of scripts to test our business application



My handover was a load of screenshots with my comments written on them.  I have subsequent gone back and changed/improved these scripts



I am starting to loose track of the details of what the test script is doing



is there any easy/automatic way that I can get a document which describes what the tests are doing?



4 Replies

  • TonyMro's avatar
    TonyMro
    Occasional Contributor
    13 years ago
    Screenshots? Screenshots of what?



    I assume that the contractor who produced the test scripts worked from a documented test procedure that describes the scope of each test case, the test steps for each test case, and the expected results. From this document, the code for each test case would have been created, and hopefully the code that was produced was well commented to correspond with the test steps and expected results being measured.
  • grant_volker_2's avatar
    grant_volker_2
    Contributor
    13 years ago
    Hi Richard,



    Perhaps you might be thinking of a feature provided by tools such as GhostDoc or NDoc3 ?

    As far as I know, TestComplete does not offer such a feature.



    I found myself in a situation like this too and reviewed the code using Notepad++ which helped me.



    Hope it works out for you!
  • richv's avatar
    richv
    Occasional Contributor
    13 years ago
    Thanks for your comments  is it possible to copy the source code in TC into notepad++
  • grant_volker_2's avatar
    grant_volker_2
    Contributor
    13 years ago
    Hi Richard,



    Notepad++ is capable of opening many document types, from File in Notepad++ open the folder containing the source files you're interested in then open the scrit files that are associated with the scripts(s) you are working with.



    If there is a particular text (e.g. variable name) you are interested in, double click on it in an opened script to view which files it occurs in. For example this will help to view where the function / variable etc occurs. I found this approach helpful to gather my wits on "what was going on" in the code.



    Please do let me know if you have any more questions.



    Wish you good results!