How To Document A Function In A Code Module Using TestStand

[TonyJ]

As a test engineer we use TestStand extensively.  We embrace the concept of a software architect.  I would like to document the functions I use in TestStand using Word or similar.  Would someone have an example I can use?  Some of the fields needed would be a parameter list, path to the .dll or .vi, description/use, which adapter to use, etc.  My vision is to have a half page or so to describe all my primary functions within TestStand.  Documenting this would assist newer test engineers who would support my test sequences.

[CharlieRodway]

Hi Tony,

This is a great question and one that often gets neglected - documentation is usually an afterthought unless it's a requirement from the customer!

If you were looking to write something in Word like a Functional Design Document for newer test engineers to pick up, you could start out with a summary of the overall architecture and include pictures of the hierarchy (View > Sequence File > Display File Hierarchy).

Then on a single page you could summarise each sequence (operation, parameters, error handling), include a flow chart and embed an auto-generated Sequence File Document HTML file as an object (Tools > Sequence File Documentation).

That's my suggestion for an initial starting point, sorry I can't attach any examples as they're confidential and it'd take a while to redact a lot of the information 

I hope this helps,

[kosist90]

Hello TonyJ,

one of solutions is to use TestStand API, and create parser for you sequences (and parser will be universal for all sequences what you'd like to document).

Via TS API, you can go through all sequences in sequence file, get all the steps, and then retreive its parameters - path, name, etc. Also, by accessing code module itself (I was doing it for LabVIEW code modules), you can retreive documentation for VI, list of inputs/outputs, and their description.

All this info, you can nicely add to Word document, and format it (let's say, each sequence will be as chapter, code module info in the table, etc.).

Once created this tool, you can reuse it for documenting the list of all used code modules.

Sincerely, kosist90

JKI VI Tester – useful tool for LabVIEW developer