Documenting the VA Topic

Morgan Berry
Tera Contributor

I have a requirement to document our changes to our VA Topics and was wondering if anyone had any tips of a report or export that could give each piece of the topic and its associated settings to allow for quick re-builds and documenting changes between sprints.

 

Also, not sure if I am crazy or not, but I could have sworn there was a way to export the workflow image to an image or a PDF (without taking and merging screenshots), but cannot seem to see it anymore, or documentation.

 

Anyone?

1 ACCEPTED SOLUTION

Chris D
Kilo Sage
Kilo Sage

Yes, you can output the topic flow to a png by opening it in VA Designer, then clicking the camera button on the top right corner (then right click > save image after it opens in a new tab):

ChrisD_0-1701959808607.png

This is the best, easiest, and (I'm fairly sure) only way to export a topic for documentation/requirement purposes. This exemplifies the importance of having good, clear node naming conventions which is the single best thing you can do: use plain, concise English, avoid abbreviations (unless maxed out character limits), and name all your decision blocks and decision outputs (don't keep the defaults). Personally I avoid special characters in input nodes so that the variable names are short and clean, but decision blocks and other outputs I use special characters (question mark is helpful for decisions) to ensure those are descriptive and clear.

The only other tip I can give you working with customers/topic SME's is to have a live meeting with them and walk them through the entire flow step by step in VA Designer so they can see the wording and specific settings.

View solution in original post

5 REPLIES 5

kumaraditya
Tera Contributor

Found a slight workaround for this, just fit the whole design flow in a single scrollable view, such that all the diagram contents appear in the 'white background' area. Print it, press Ctrl+P. Adjust the following print settings:

Paper Size - A0

Margins - Minimum
Scale % - 120 (depending on your flow size, pixelation won't happen anyways, will be crisp clear)

Just print it after these steps and you're good to go. Hope this might help the audience 🙂
Upvote this if it was helpful to you.