US - Washington DC - CRM

Expand all | Collapse all

Willing to share sample/template for technical documentation?

  • 1.  Willing to share sample/template for technical documentation?

    Posted Feb 27, 2018 12:06 PM
    Edited by Karyn Dubravetz May 16, 2018 03:00 PM
    Hi everyone,

    I have been tasked with writing some documentation for our CRM (we are on 2013 version).

    Does anyone have a sample or template they'd be willing to share? Or any tips?

    Thanks much,
    Karyn

    ------------------------------
    Karyn Dubravetz
    Corporation for Public Broadcasting
    Washington DC
    ------------------------------


  • 2.  RE: Willing to share sample/template for technical documentation?

    MICROSOFT MVP
    Posted Feb 28, 2018 08:57 AM
    Hi Karyn,

    I don't have a template to share but I've been in similar situations before. There are two very different items you're trying to document. What/how does it work, and why does it work that way.

    The what and how may be easy or hard to document depending on your level of custom work. Javascript is fairly readable even if you don't know the language. Custom plugins can be difficult with the source code, and a nightmare without it.

    The why will be harder - I could come in to an organization and document every custom behavior their CRM has without knowing why any of it was done. To get that, you need to either rely on documentation, identify it as supporting a business process (which you might now know), or rely on the organizations oral tradition to tell you why it was done that way. In many cases you might find nobody knows why it was done that way.

    Thanks,
      Aiden

    ------------------------------
    Aiden Kaskela, Microsoft Business Solutions MVP
    President
    Kaskela Solutions, Inc.
    Alexandria VA
    ------------------------------



  • 3.  RE: Willing to share sample/template for technical documentation?

    TOP CONTRIBUTOR
    Posted Feb 28, 2018 12:41 PM
    We don't really have a template for this right now. It really depends on the project and how complex it is.

    For workflows - we try to use Visio to map out the logic and flow. This is especially beneficial with the more complex processes. We also use Visio to map our integrations.

    I would also recommend you look at the XRM Toolbox Metadata document generator. This allows you to get a list of all the fields for a particular entity with all of their settings (Audit, FLS, etc.). Then you can use this to store a current state or as the start for some kind of data dictionary.

    Good luck!

    ------------------------------
    Kylie Kiser
    Supervisor, CRM System
    Fairfax VA

    crmug.com/washington
    ------------------------------



  • 4.  RE: Willing to share sample/template for technical documentation?

    Posted Feb 28, 2018 05:15 PM
    Edited by Karyn Dubravetz May 16, 2018 03:00 PM
    Thanks for your responses.

    Kylie - Thanks, I will check out the Metadata document generator. Nice to know I won't have to try to capture all that manually.

    Aiden - Thanks for the input - very true!
    Karyn

    ------------------------------
    Karyn Dubravetz
    Corporation for Public Broadcasting
    Washington DC
    ------------------------------