3,311
edits
Changes
Jump to navigation
Jump to search
Line 5:
Line 5: − + + + + + + + + + +
How to document your solutions (view source)
Revision as of 12:42, 20 December 2021
, 12:42, 20 December 2021no edit summary
Examples of what documentation that is useful to have:
Examples of what documentation that is useful to have:
* Entity tionship RD ()
* 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.
* Integrations - What integrations there are, diagram illustrating integration flows, integration techniques, mappings
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 on the XTB page]
* [https://www.xrmtoolbox.com/plugins/LinkeD365.ERDVisioBuilder/ Visio Builder on the XTB page]