Book a Demo

Author Topic: Documentation in the MDG itself  (Read 3613 times)

Paolo F Cantoni

  • EA Guru
  • *****
  • Posts: 8626
  • Karma: +259/-129
  • Inconsistently correct systems DON'T EXIST!
    • View Profile
Documentation in the MDG itself
« on: February 20, 2020, 12:29:58 pm »
In the past, with our "hand-crafted" MDG, we placed comments in the MDG to explain things.

With the Model-based MDG generation, is it possible to pass such narrative through to the generated MDG?

TIA,
Paolo
Inconsistently correct systems DON'T EXIST!
... Therefore, aim for consistency; in the expectation of achieving correctness....
-Semantica-
Helsinki Principle Rules!

Geert Bellekens

  • EA Guru
  • *****
  • Posts: 13523
  • Karma: +574/-33
  • Make EA work for YOU!
    • View Profile
    • Enterprise Architect Consultant and Value Added Reseller
Re: Documentation in the MDG itself
« Reply #1 on: February 20, 2020, 04:15:00 pm »
I don't think so, but you can document your MDG model instead.
Isn't that much better?

Geert

Paolo F Cantoni

  • EA Guru
  • *****
  • Posts: 8626
  • Karma: +259/-129
  • Inconsistently correct systems DON'T EXIST!
    • View Profile
Re: Documentation in the MDG itself
« Reply #2 on: February 20, 2020, 04:34:29 pm »
I don't think so, but you can document your MDG model instead.
Isn't that much better?

Geert
Yes, Geert, I fully intend to do that! ;)

I was hoping there would be a mechanism to get some of that into the MDG.  If you're trying to track down a "silent fail", it might be useful to have some narrative to help.

If there was, I can keep documenting the current MDG and then transfer the commentary to the model at the appropriate time.

I'll pop in a feature request at some time.

Paolo
Inconsistently correct systems DON'T EXIST!
... Therefore, aim for consistency; in the expectation of achieving correctness....
-Semantica-
Helsinki Principle Rules!

qwerty

  • EA Guru
  • *****
  • Posts: 13584
  • Karma: +397/-301
  • I'm no guru at all
    • View Profile
Re: Documentation in the MDG itself
« Reply #3 on: February 20, 2020, 07:50:41 pm »
I have managed to generate MDGs via script without (almost) all those silly file exports. Only profiles need to be saved and here I got a maker in the notes which ensures I get the right file. So for any change I just call my script and it creates the MDG sanely. Take that.

q.

Geert Bellekens

  • EA Guru
  • *****
  • Posts: 13523
  • Karma: +574/-33
  • Make EA work for YOU!
    • View Profile
    • Enterprise Architect Consultant and Value Added Reseller
Re: Documentation in the MDG itself
« Reply #4 on: February 20, 2020, 08:11:24 pm »
I have managed to generate MDGs via script without (almost) all those silly file exports. Only profiles need to be saved and here I got a maker in the notes which ensures I get the right file. So for any change I just call my script and it creates the MDG sanely. Take that.

q.

In one of the more recent versions they added API support for exporting UML profiles as well.
This should enable you to automate the whole process without any manual steps.

Geert

PS. Not sure how this helps with documentation in the MDG though :-\