Well … that’s exactly what I described above tbh - build a library that contains activities (and now, thanks to the objects repo, selectors too) which is a pretty standard approach.
However, the problem I was trying to address in my original message is the “black-box” effect where, once the library is published, you have no insight into what’s happening inside any specific activity (and what you can expect that activity to return e.g. exceptions-wise)
On top of that, end-users (of that library) must do quite some manual work to plug it into the workflow (mostly revolving around exception handling) and since those users might be non-tech ones, they might not even realise they need to do any additional actions to ensure their workflows run stable.
As of now a “solution” to that “black-box” effect is directing the user to the documentation where each activity is described and appended with a list of possible exceptions etc etc. then, from that documentation the user is redirected to a repository of snippets where (s)he can see the actual examples of usage of those reusable activities.
The problem is that it’s quite a few steps for the end-user to take in order to learn what’s inside that particular activity and what are the possible outcomes, and even more actions to see an actual workflow that showcases it’s (library activity) usage.
- adding those examples of usage to the library as an additional file is not an option since every xaml file is treated as an activity (black-box)
- Object Repository doesnt seem to allow anything but selectors
Hence me suggesting that there should be a way to attach raw xaml files to the library → those raw files could be displayed in the snippets section under the name of the library and would serve as the closest activity documentation possible
I built a library acme.application.activities
In that library I’ve put wonderful activity which throws various exceptions
Once I’ve published it and imported into a project all I can see (unless I look for the documentation) is this:
I wanted to make my end-users’ lives easier so I created an example how they can use my activity (e.g. what exceptions are thrown)
- attach the screenshot to the documentation which would be poor UX
- attach the xaml file to the documentation which would be fine but not really maintainable
- save it into a repository again bad UX
- save it into a network drive (which is linked to the studio as a source of snippets) but then all of my users would be flooded with snippets that are not relevant to them
So all of the above solutions are not really user friendly
Now, what I’m looking for would a way to distribute snippets together with libraries:
I’d like to be able to attach my “Wonderful Activity.xaml” snippet directly to the acme.application.activities and whenever that library is imported into a project, I’d expect snippets to be displayed in the Snippets or Samples section of the studio
This way, the end users would get a copy-paste experience rather than “wander around until I find some docs”
Hope that makes sense now
Have a good one,