SPONSORS:






User Tag List

Thanks Thanks:  0
Likes Likes:  0
Dislikes Dislikes:  0
Page 1 of 2 12 LastLast
Results 1 to 10 of 14
  1. #1
    Senior Member
    Join Date
    Feb 2003
    Posts
    533
    Post Thanks / Like
    Mentioned
    0 Post(s)
    Tagged
    0 Thread(s)
    Total Downloaded
    0

    Templates for script documentation?

    Has anyone done documentation of the scripts. Something like a user manual doc explaining how to run an automated test, what are the pre-requisites to run an automated test. Also a technical document that explains the code logic. Basically like we have a functional & technical specs in normal programming. If anyone has any template to share then please share the same.
    Thanks

  2. #2
    Senior Member
    Join Date
    Feb 2003
    Posts
    533
    Post Thanks / Like
    Mentioned
    0 Post(s)
    Tagged
    0 Thread(s)
    Total Downloaded
    0

    Re: Templates for script documentation?

    No response????

    Does that mean that writing automated testing script spec docs is not usual? In a group of automated testing, how you do the code reviews or knowledge sharing of the code & logic applied.

  3. #3
    Senior Member
    Join Date
    Jan 2006
    Location
    Stockholm, Sweden
    Posts
    371
    Post Thanks / Like
    Mentioned
    0 Post(s)
    Tagged
    0 Thread(s)
    Total Downloaded
    0

    Re: Templates for script documentation?

    I try to comment the code for each block but I don't follow any standard. I also try to name the functions so that the usage becomes obvious, like ExecuteTestCase, CheckForErrors, GetDatabaseValue, VerifyText etc in order to have the code "self-explained".

    Then I have higher level documentation of my test framework in a word document where I try to give examples of implementation, for example how to create a new test case.

  4. #4
    Advanced Member
    Join Date
    Aug 2007
    Location
    Six Feet Under
    Posts
    717
    Post Thanks / Like
    Mentioned
    0 Post(s)
    Tagged
    0 Thread(s)
    Total Downloaded
    0

    Re: Templates for script documentation?

    i have but i have all Personal information so i'll remove that and then upload by editing this post give me sometime

    Thanks
    Manish Bansal
    Thanks,
    Manish Bansal

    Checkout Blog Page At
    http://www.softtechlabs.com

  5. #5
    Senior Member
    Join Date
    Feb 2003
    Posts
    533
    Post Thanks / Like
    Mentioned
    0 Post(s)
    Tagged
    0 Thread(s)
    Total Downloaded
    0

    Re: Templates for script documentation?

    Thanks Manish. I will wait for your post.

  6. #6
    Member
    Join Date
    Dec 2007
    Posts
    66
    Post Thanks / Like
    Mentioned
    0 Post(s)
    Tagged
    0 Thread(s)
    Total Downloaded
    0

    Re: Templates for script documentation?

    Manish, I too require the document
    Thanks,
    Mahesh Dasari

  7. #7
    Senior Member
    Join Date
    Oct 2001
    Location
    Cambridge, MA, USA
    Posts
    263
    Post Thanks / Like
    Mentioned
    0 Post(s)
    Tagged
    0 Thread(s)
    Total Downloaded
    0

    Re: Templates for script documentation?

    The bulk of my code is in .VBS files, which contain comments in a specified format. I use the tool VBDOX to process these files because it translates the comments into handsome HTML pages. (See the VBDOX help for the expected formatting...it allows a few different options).

  8. #8
    Advanced Member
    Join Date
    Aug 2007
    Location
    Six Feet Under
    Posts
    717
    Post Thanks / Like
    Mentioned
    0 Post(s)
    Tagged
    0 Thread(s)
    Total Downloaded
    0

    Re: Templates for script documentation?

    Hi,
    Please find the template document
    Still there are lots of other things witch can be added to this document and we can make this a standard community scripting documents template

    I have purposely removed lots of sensitive information so that size of this document become small but I feel most of important informationís have been covered

    This document can be use by a new automation tester to understand the scripts written by others tester for knowledge Transfer and it can be a crucial role as a handover document.

    Letís make it more transparentÖ

    Regards,
    Manish Bansal
    Attached Files Attached Files
    Thanks,
    Manish Bansal

    Checkout Blog Page At
    http://www.softtechlabs.com

  9. #9
    Advanced Member
    Join Date
    Aug 2007
    Location
    Six Feet Under
    Posts
    717
    Post Thanks / Like
    Mentioned
    0 Post(s)
    Tagged
    0 Thread(s)
    Total Downloaded
    0

    Re: Templates for script documentation?

    guys am waiting for suggestion and improvement in this this document..
    if u haven't downloaded yet just click on the attachment and download it from the earlier post of mine


    Regards,
    Manish Bansal
    Thanks,
    Manish Bansal

    Checkout Blog Page At
    http://www.softtechlabs.com

  10. #10
    Senior Member
    Join Date
    Jan 2000
    Location
    USA, CA
    Posts
    1,998
    Post Thanks / Like
    Mentioned
    0 Post(s)
    Tagged
    0 Thread(s)
    Total Downloaded
    0

    Re: Templates for script documentation?

    I would not name this document
    as Script Documentation template at all.
    It is private documentation of your test flow
    or your Framework design or whatever you name it.
    It might be good and correct for your specific project, according your individual vision of documentation,
    but it can not be treated as General documentation template.

    Scripts documentation should describe each Function or Sub included in the Script along with parameters required for Function, returned values and types of that returns. With example of using, of course.
    There is lot of tools on the marker, that can generate formal docs from codes comments. They are using different format of representation (MSDN style, WinHelp style and so on...), but main idea is similar: after reading that docs - user of library(in our case: Automator, who will use documented Functions in QTP TestCases) should have complete knowledge of WHAT and HOW to use Functions included.
    derekk mentioned using VBDOC for this purpose. In my opinion - it is very good free tool for documenting VBscripts.
    For today: The best tool for codes documentation is docs generator of TestDesignStudio. It is professionally implemented and easy to use. It gives absolutely professional output codes documentation according high level of docs standards.

    Janna

 

 
Page 1 of 2 12 LastLast

Posting Permissions

  • You may not post new threads
  • You may not post replies
  • You may not post attachments
  • You may not edit your posts
  •  
Search Engine Optimisation provided by DragonByte SEO v2.0.36 (Pro) - vBulletin Mods & Addons Copyright © 2016 DragonByte Technologies Ltd.
Resources saved on this page: MySQL 9.09%
vBulletin Optimisation provided by vB Optimise v2.6.4 (Pro) - vBulletin Mods & Addons Copyright © 2016 DragonByte Technologies Ltd.
User Alert System provided by Advanced User Tagging v3.2.8 (Pro) - vBulletin Mods & Addons Copyright © 2016 DragonByte Technologies Ltd.
vBNominate (Lite) - vBulletin Mods & Addons Copyright © 2016 DragonByte Technologies Ltd.
Feedback Buttons provided by Advanced Post Thanks / Like (Pro) - vBulletin Mods & Addons Copyright © 2016 DragonByte Technologies Ltd.
Username Changing provided by Username Change (Free) - vBulletin Mods & Addons Copyright © 2016 DragonByte Technologies Ltd.
BetaSoft Inc.
Digital Point modules: Sphinx-based search
All times are GMT -8. The time now is 02:32 AM.

Copyright BetaSoft Inc.