web
You’re offline. This is a read only version of the page.
close
Skip to main content

Notifications

Announcements

No record found.

Community site session details

Community site session details

Session Id :
Microsoft Dynamics CRM (Archived)

Best practices, documentation of Dynamics CRM applications

(0) ShareShare
ReportReport
Posted on by 125

I'm not sure if this is the appropriate place to be asking this, but I'm looking for some advice.

I've been given the opportunity to become an internal developer resource with the Dynamics CRM platform, but due to my minimal experience in actually being a developer (I used to do end user support), I'm a little lost on best practices for documentation.  I'm looking for some advice on proper ways to document entities and other parts of entities for of any applications I develop in the system.

As of now, I've been using Visio files to create a basic workflow structure that will contain the form layout, fields, relationships, ect.  I then have another section on the form to display any JavaScript that is running on the form, what fields they affect, and what it does.  I also have another section that contains any of the option sets on the form, and any lookup values.  If the entity contains a workflow/business process, I also include that in this Visio file.

I feel like what I'm doing is overkill, and was wondering what you do for documenting anything you develop in CRM.  Any advice would be greatly appreciated.

*This post is locked for comments

I have the same question (0)
  • Verified answer
    Hosk Profile Picture
    on at

    You could maybe try this tool to automate the process

    mscrmtoolkit.codeplex.com/documentation

    I don't usually document the entities but do keep logs of the workflows, plugins etc, on a wiki

  • Verified answer
    Mamatha Swamy Profile Picture
    5,426 on at

    There is tool called Metadata documentation generator that can get you all that information instead  of you doing it manually. With the metadata taken care, you can document your process flows and use cases using visio.

    You can download the tool from xrmtoolbox.codeplex.com

    chk screenshots metadatadocgenerator.codeplex.com

  • Nate Arms Profile Picture
    125 on at

    Wow, I wish I would have known about this tool earlier, thanks so much.

  • Nate Arms Profile Picture
    125 on at

    Thanks!  I'm going to see about creating a Wiki, I didn't even consider doing that.  Thanks for the application link too.

  • Community Member Profile Picture
    on at

    Nate,

    I had similar query some time back - under this thread. You see a couple of good plug in coding standards followed.

    community.dynamics.com/.../108883.aspx

    Thought it will be helpful for others to link from here.

    Best wishes and success to you on your developer role.

    kind regards,

    harihar

Under review

Thank you for your reply! To ensure a great experience for everyone, your content is awaiting approval by our Community Managers. Please check back later.

Helpful resources

Quick Links

Responsible AI policies

As AI tools become more common, we’re introducing a Responsible AI Use…

Neeraj Kumar – Community Spotlight

We are honored to recognize Neeraj Kumar as our Community Spotlight honoree for…

Leaderboard > 🔒一 Microsoft Dynamics CRM (Archived)

#1
SA-08121319-0 Profile Picture

SA-08121319-0 4

#1
Calum MacFarlane Profile Picture

Calum MacFarlane 4

#3
Alex Fun Wei Jie Profile Picture

Alex Fun Wei Jie 2

Last 30 days Overall leaderboard

Featured topics

Product updates

Dynamics 365 release plans