Updated examples and documentation for 0.3.0

Updated examples based on 0.3.0 Added smaller additional info on how to generated documentation for Solutions
modery · Oct 31, 2021 · 5d2c95d · 5d2c95d
1 parent 80c2a5d
commit 5d2c95d
Show file tree

Hide file tree

Showing 15 changed files with 37 additions and 7 deletions.
diff --git a/Images/AdminSyncTemplatev3Apps-documented-actions.png b/Images/AdminSyncTemplatev3Apps-documented-actions.png
diff --git a/Images/AdminSyncTemplatev3Apps-whole-Word-doc.png b/Images/AdminSyncTemplatev3Apps-whole-Word-doc.png
diff --git a/Images/AdminSyncTemplatev3Apps.png b/Images/AdminSyncTemplatev3Apps.png
diff --git a/Images/PowerDocu.FlowDocumenter-generated-output.png b/Images/PowerDocu.FlowDocumenter-generated-output.png
diff --git a/Images/PowerDocu.GUI.png b/Images/PowerDocu.GUI.png
diff --git a/Images/Solution-CoEStartKit-AuditComponents.png b/Images/Solution-CoEStartKit-AuditComponents.png
diff --git a/Images/Weather-Flow-Documentation-1.png b/Images/Weather-Flow-Documentation-1.png
diff --git a/Images/Weather-Flow-Documentation-2.png b/Images/Weather-Flow-Documentation-2.png
diff --git a/Images/Weather-Flow-Processed-Example.png b/Images/Weather-Flow-Processed-Example.png
diff --git a/README.md b/README.md
@@ -3,15 +3,15 @@ After you have built a Flow in Power Automate, you may consider documenting it a
 
 This is where **FlowDocumenter** can help!
 
-Currently, this repository contains a solution to document Power Automate Flows, called **FlowDocumenter**. FlowDocumenter allows the automatic generation of technical documentation based on a provided exported Flow package.
+Currently, this repository contains a solution to document Power Automate Flows, called **FlowDocumenter**. FlowDocumenter allows the automatic generation of technical documentation based on a provided exported Flow package or an exported Solution package.
 
 ![Example of generated Word documentation](Images/Weather-Flow-Documentation-1.png)
 ![Example of generated Word documentation](Images/Weather-Flow-Documentation-2.png)
 
 
 ## What is generated as part of the technical documentation?
 
-The documentation includes
+The documentation for each Flow includes
 
 1. A generated Word document including sections on
  1. General information of the Flow

diff --git a/examples/AdminSyncTemplatev3Apps.docx b/examples/AdminSyncTemplatev3Apps.docx
diff --git a/examples/Email me with a list of upcoming Calendar events.docx b/examples/Email me with a list of upcoming Calendar events.docx
diff --git a/examples/Solution CenterofExcellenceCoreComponents_3.13_managed.zip b/examples/Solution CenterofExcellenceCoreComponents_3.13_managed.zip
diff --git a/examples/examples.md b/examples/examples.md
@@ -1,7 +1,7 @@
 # Examples of PowerDocu FlowDocumenter
 
 ## Template: Email me with a list of upcoming Calendar events
-The freely available template [Email me with a list of upcoming Calendar events](https://emea.flow.microsoft.com/en-us/galleries/public/templates/99892410786e4d6888f27ae380125a80/email-me-with-a-list-of-upcoming-calendar-events/) uses 3 different connectors and a few actions, including some control actions.
+The freely available Power Automate Flow template [Email me with a list of upcoming Calendar events](https://emea.flow.microsoft.com/en-us/galleries/public/templates/99892410786e4d6888f27ae380125a80/email-me-with-a-list-of-upcoming-calendar-events/) uses 3 different connectors and a few actions, including some control actions.
 
 
 ![Email me with a list of upcoming Calendar events](../Images/Weather-Flow.png)
@@ -21,3 +21,20 @@ Here is an extract of the generated Word documentation:
 ![Email me with a list of upcoming Calendar events](../Images/Weather-Flow-Documentation-2.png)
 
 The generated Word documentation for *Email me with a list of upcoming Calendar events* can also be downloaded here: [Email me with a list of upcoming Calendar events](Email%20me%20with%20a%20list%20of%20upcoming%20Calendar%20events.docx)
+
+
+## Template: Email me with a list of upcoming Calendar events
+Microsoft provides the free [Microsoft Power Platform Center of Excellence (CoE) Starter Kit](https://github.com/microsoft/coe-starter-kit/). "The Center of Excellence (CoE) Starter Kit is a set of templates that are designed to help develop a strategy for adopting, maintaining and supporting the Power Platform, with a focus on Power Apps and Power Automate." Among other things, it contains a few Flows as part of various Solutions.
+
+One of these solutions, [CenterofExcellenceCoreComponents_3.13_managed.zip](https://github.com/microsoft/coe-starter-kit/releases/tag/CoEStarterKit-October2021), has been processed through FlowDocumenter, and the documentation that has been generated is available here: [Solution CenterofExcellenceCoreComponents_3.13_managed](Solution CenterofExcellenceCoreComponents_3.13_managed.zip). 
+
+An extract of the generated documentation of one of its Flows, AdminSyncTemplatev3Apps, is listed below. Its generated Word documentation is available here: [AdminSyncTemplatev3Apps.docx](AdminSyncTemplatev3Apps.docx)
+
+Detailed Graph of the Flow
+![AdminSyncTemplatev3Apps](../Images/AdminSyncTemplatev3Apps.png)
+
+27 pages of generated documentation
+![AdminSyncTemplatev3Apps](../Images/AdminSyncTemplatev3Apps-whole-Word-doc.png)
+
+Example of the documented actions
+![AdminSyncTemplatev3Apps](../Images/AdminSyncTemplatev3Apps-documented-actions.png)
diff --git a/installation.md b/installation.md
@@ -32,14 +32,27 @@ To generate documentation for a Flow, you need to export it from the web as a ZI
 
 ## Run FlowDocumenter
 
-Run FlowDocumenter by doing the following:
+You can run FlowDocumenter by either using the PowerDocu.GUI Windows application or the PowerDocu.FlowDocumenter console application. Both applications generate the same set of documentation:
 
+**Flow Package**
+
+A new folder will be created within the current folder, using the exported Flow's name as folder name. Inside this folder you can find the generated diagrams as well as the generated documentation
+![Email me with a list of upcoming Calendar events](Images/PowerDocu.FlowDocumenter-generated-output.png)
+
+**Solution Package**
+
+A folder with the Solution package file's name will be created, and each individual Flow will be processed and its generated files stored inside this folder
+![Email me with a list of upcoming Calendar events](Images/Solution-CoEStartKit-AuditComponents.png)
+
+### Use the PowerDocu.GUI
 1. Open a command prompt or PowerShell window in the folder that contains FlowDocumenter
 2. Execute FlowDocumenter and provide an exported Flow package as parameter. For example: *PowerDocu.FlowDocumenter.exe FlowPackage.zip*
-![Execute FlowDocumenter](Images/PowerDocu.FlowDocumenter-run.png)
-3. A new folder will be created within the current folder, using the exported Flow's name as folder name. Inside this folder you can find the generated diagrams as well as the generated documentation
-![Email me with a list of upcoming Calendar events](Images/PowerDocu.FlowDocumenter-generated-output.png)
+![Execute FlowDocumenter](Images/PowerDocu.GUI.png)
 
+### Run the PowerDocu.FlowDocumenter console application
+1. Open a command prompt or PowerShell window in the folder that contains FlowDocumenter
+2. Execute FlowDocumenter and provide an exported Flow or Solution package as parameter. For example: *PowerDocu.FlowDocumenter.exe FlowPackage.zip*
+![Execute FlowDocumenter](Images/PowerDocu.FlowDocumenter-run.png)
 
 ## Use custom Word style formatting