Automation Summarizer Documentation Feedback

[AndyMenon]

Hello Team,

I’m currently exploring the Automation Summarizer Solution Accelerator template and wanted to leave a feedback rather than a review in the public Marketplace.

The template appears to be qualitatively working. So far, the instructions I’ve followed to deploy the package via Automation Ops hasn’t let me down. But regardless of that outcome, the following improvements could be made to make this template that much easier to consume with small but significant edits. Especially, if the end goal of a Solution Accelerator is to ease the implementation of a solution.

Sorry, if I missed something or have misread the documentation. I’m willing to correct myself.

Presumption to the Instructions

The deployment documentation has been written assuming that an end user has predefined knowledge that is equivalent to that of the creator of this template. This may not always be the case.

Here’s an example:

There are two credential assets in the settings. But the documentation does not state their purpose (especially the O365 Azure credentials). A one line description of where they are used in the template would be excellent and instantly helpful. The end user of the template does not have to spend more time trying to figure that out. Instead, that time could be spent focusing on the core functionality of the template.

High Level Solution Design

I opened this first given that it is high level, and came to the conclusion that this SA template has more than one Performer. But later on I realized that it’s just one performer. Given it’s high-level intent, I believe it must capture a bit more clarity.

Maybe, this could be replaced with a flow chart that shows the workings of a single performer?

Abrupt ending of Instructions

I can see gaps in the documentation that an aspiring Solutions Architect might spend more time than needed to reason how this SA template works.

Example: Section 1.4. (page 18)

What happens after the end user copies the User Key and Client Id and clicks OK? The instruction ends abruptly with no description for the second image. It’s assumed that the user knows what to do with the User Key and Client Id. What must go into the Username, and what must be the Password ? User Key or Client Id?

Unrelated references

On Page 9 there is a reference to AP Invoice Processing. How does this reference relate to this Solution Accelerator?

Documentation Packaging

Several benign references have been included in the documentation. The MS Word lock files left behind is not very appealing and appears messy.

Thanks.

@loginerror
@evan.cohen