Book a Demo

Author Topic: Wrong chapter title in the help?  (Read 3579 times)

dams

  • EA User
  • **
  • Posts: 20
  • Karma: +0/-0
    • View Profile
Wrong chapter title in the help?
« on: February 09, 2009, 05:55:17 pm »
Hello,
Is "Enterprise Architect Object Model" the right name for Automation Interface in the help of EA (834)?
English is not my mother language, but Object Model lets me think to something to classify near the Class Model, Requirement Model...
I didn't find the Automation Interface intuitively and was surprised to discover it in the chapter named "Enterprise Architect Object Model".
"Enterprise Architect API" would be more intuitive. No?

«Midnight»

  • EA Guru
  • *****
  • Posts: 5651
  • Karma: +0/-0
  • That nice Mister Grey
    • View Profile
Re: Wrong chapter title in the help?
« Reply #1 on: February 09, 2009, 11:34:34 pm »
Probably that would be a better name, but Object Model is also common usage for this kind of thing.

Perhaps the idea was to avoid confusion with the Add-in API, though the same kind of logic might hold there. [I.e. you could have the Add-in API, the Automation API, etc.]

Some of this might date back quite a while. A couple of years ago the documentation for the API - all API functions - got collected into a beta version of the EA SDK. The SDK would have been a collection of anything used to automate or extend EA beyond the boundaries that UML defined. The beta did not receive much publicity and was not widely discussed here in the forum. [Nor was it hidden. It was just 'quieter' than something like the beta of a new EA version.]

The SDK never saw the light of day, but did lead to some extensions and improvements in the documentation portions that were involved. About the time EA 6 (I think) came out the SDK was reintegrated into the main help file and user guide; that's what you see today.

During this process it became necessary to give names to individual SDK sections that were distinct from each other, not too different from the legacy documentation (so the then-current user base would know where to look), and provided some clue to what each section contained. I think the first shot at these names - remember that the SDK never got beyond the beta stage - just stuck.

HTH, David
No, you can't have it!

dams

  • EA User
  • **
  • Posts: 20
  • Karma: +0/-0
    • View Profile
Re: Wrong chapter title in the help?
« Reply #2 on: February 09, 2009, 11:43:17 pm »
Thanks for this explanation.
Dams