Dynamics Community Forum Thread Details

Best Practices for Documenting Customizations in Model-Driven Apps

Hi everyone,

I'm building a custom model-driven app and I'm looking for best practices around documenting customizations, both technical and functional.

For example, if a new team member joins the project, what's the ideal documentation setup to help them get up to speed? I'm particularly focused on the technical side, but I’d also love to hear thoughts on what’s most helpful from a functional perspective.

Here are some specific questions I have:

How should I document logic tied to form events (like onLoad, onSave, etc.)?

What’s the best way to document plugins, workflows, and Power Automate flows?

Would sequence diagrams be helpful? And if so, how should they be structured?

Should I create separate documents/files for each type of customization?

Do you recommend a specific folder structure?

For instance, I was thinking of something like:

Entity Name/

├── Forms/

│ ├── OnLoad/

│ └── OnSave/

├── Plugins/