Difference between revisions of "How to document your solutions"
Jump to navigation
Jump to search
| (7 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
| − | This page gathers information about | + | This page gathers information about what documentation is needed for your Power Platform solutions. |
== General == | == General == | ||
| Line 7: | Line 7: | ||
* Best Practice and naming conventions - Best to figure this out before you start with your project in order to establish a common way of working. | * Best Practice and naming conventions - Best to figure this out before you start with your project in order to establish a common way of working. | ||
| − | * Entity Relationship Diagram (ERD) visualizing the essential OOTB Tables that make up your solution as well as all custom tables and the relationships in between | + | * Entity Relationship Diagram (ERD) visualizing the essential OOTB Tables that make up your solution as well as all custom tables and the relationships in between. |
| − | * Environments that are used and settings specific for each environment (that are not deployed through solutions, e.g. search settings or configuration data) | + | * Environments that are used and settings specific for each environment (that are not deployed through solutions, e.g. search settings or configuration data). |
| − | * ALM and deploy procedure - info about pipelines, the setup and who is responsible for deploys | + | * ALM and deploy procedure - info about pipelines, the setup and who is responsible for deploys. |
* Solution Components - Description of Tables, relationships in between, Business Rules, Business Process Flows (BPF), Cloud flows, Plugins etc. | * Solution Components - Description of Tables, relationships in between, Business Rules, Business Process Flows (BPF), Cloud flows, Plugins etc. | ||
| − | * Integrations - What integrations there are, diagram illustrating integration flows, integration techniques, mappings | + | * For Canvas Apps - Data Sources |
| + | * Integrations - What integrations there are, diagram illustrating integration flows, integration techniques, mappings. | ||
| + | * Functional description | ||
If Azure DevOps is used, a Project Wiki can be used to store information about environments, settings and pipelines. If Microsoft Teams is used, a OneNote can be used as wiki. | If Azure DevOps is used, a Project Wiki can be used to store information about environments, settings and pipelines. If Microsoft Teams is used, a OneNote can be used as wiki. | ||
== Tools == | == Tools == | ||
| − | * [https://www.xrmtoolbox.com/plugins/LinkeD365.ERDVisioBuilder/ Visio Builder | + | There are some tools to be used as part of creating documentation for your solutions. |
| + | |||
| + | * [https://www.xrmtoolbox.com/plugins/LinkeD365.ERDVisioBuilder/ XTB - ERD Visio Builder] | ||
| + | * [https://www.xrmtoolbox.com/plugins/LinkeD365.FlowToVisio/ XTB - Flow to Visio] | ||
| + | * [https://www.xrmtoolbox.com/plugins/ExportSecurityRole/ XTB - Role Documenter] | ||
| + | * [https://www.xrmtoolbox.com/plugins/MsCrmTools.MetadataDocumentGenerator/ XTB - Metadata Document Generator] | ||
| + | * [https://www.xrmtoolbox.com/plugins/LinkeD365.BotToVisio/ XTB - PVA to Visio Builder] (In progress) | ||
| + | * [https://jonasr.app/uml/ XTB - UML Diagram Generator] | ||
| + | * [https://github.com/modery/PowerDocu Power Docu] to document Power Apps canvas apps and Power Automate flows | ||
Latest revision as of 07:45, 16 November 2022
This page gathers information about what documentation is needed for your Power Platform solutions.
General
So you have created a Power Platform solution and users are now using it in a production environment. In order to be able to maintain the solution over time it is important to establish and maintain documentation as well.
Examples of what documentation that is useful to have:
- Best Practice and naming conventions - Best to figure this out before you start with your project in order to establish a common way of working.
- Entity Relationship Diagram (ERD) visualizing the essential OOTB Tables that make up your solution as well as all custom tables and the relationships in between.
- Environments that are used and settings specific for each environment (that are not deployed through solutions, e.g. search settings or configuration data).
- ALM and deploy procedure - info about pipelines, the setup and who is responsible for deploys.
- Solution Components - Description of Tables, relationships in between, Business Rules, Business Process Flows (BPF), Cloud flows, Plugins etc.
- For Canvas Apps - Data Sources
- Integrations - What integrations there are, diagram illustrating integration flows, integration techniques, mappings.
- Functional description
If Azure DevOps is used, a Project Wiki can be used to store information about environments, settings and pipelines. If Microsoft Teams is used, a OneNote can be used as wiki.
Tools
There are some tools to be used as part of creating documentation for your solutions.
- XTB - ERD Visio Builder
- XTB - Flow to Visio
- XTB - Role Documenter
- XTB - Metadata Document Generator
- XTB - PVA to Visio Builder (In progress)
- XTB - UML Diagram Generator
- Power Docu to document Power Apps canvas apps and Power Automate flows