How to produce interesting documentation with OO
Hi How to produce interesting documentation with OO, especcially when using sub flows, What are best practice flow developpement that helps ending with usefull documentation.
Have you tried the generate documentation option ?
Click any "Library" folder of any project--> right click --> choose generate documentation
Check the outcome...:-)
Your best resource is going to be the Studio Authoring Guide on HP Live Network. It has a "Best Practice" callouts throughout the document that you can use. Here's the direct link to the HPOO page on HPLN:
Also, look at some of the published Content Packs (both from HP and the Community) to get some ideas on how to write good Descriptions.
My big ones that I tell people (and some of these are in the Studio Authoring Guide I already mentioned) are:
- Make your flow self-documenting. By that I mean, steps and variables with descriptive names and use the "Icons" feature to make it easy to get an idea of what the flow is doing just by looking at it. This also applies to the name and icon the flow (whether it's a primary flow or a sub-flow).
- Write a good "Description" with a brief summary of what the flow does, a list of inputs, outputs, and responses along with details for each
- Keep each flow as small as possible and use sub-flows when a task will take several steps.
These three items will go a long way in making your "generate documentation" output look nice.
So, I noticed this morning that HPE updated the HPLN site (it looks much nicer by the way) so my links from before may not work. However, now they have a handy Best Practices section with an entire doc dedicated to Best Practices for Authoring. I think that will do an even better job at handling what you need. The Best Practices section can be found at https://hpln.hpe.com/product/operations-orchestration/resources/best-practices