Book a Demo

Author Topic: use of documentation standards  (Read 2245 times)

hansh

  • EA Novice
  • *
  • Posts: 2
  • Karma: +0/-0
    • View Profile
use of documentation standards
« on: April 09, 2009, 07:56:31 pm »
Within our project we want to use model driven design. This implies a certain structuring of the models. We are also obliged to provide documentation in accordance to a documentation standard. Our first idea was to use one set of models and generate the various documents by menas of different templates. Each template should select those models and other data asked for by the documentation standard for that particular document.

We experienced we can indeed generate a document complying with the documentation standaard but where forced to structure our models in accordance with the table of contents for the specific document. This is in contradiction of having one set of models and than genreate  the various documents from this set as each document has its own structure and would require a different structure for the set of models.

Can anyone tell me;
if it is possible with EA to generate such a documentation tree from one set of models?
If it is possible how it should be done
If somenone has experience with this approach and can share does and don'ts

Thanks in advance

Hans H  

Geert Bellekens

  • EA Guru
  • *****
  • Posts: 13523
  • Karma: +574/-33
  • Make EA work for YOU!
    • View Profile
    • Enterprise Architect Consultant and Value Added Reseller
Re: use of documentation standards
« Reply #1 on: April 09, 2009, 09:38:21 pm »
In my experience, if you have very specific requirements for your generated documents, you are better of creating your own documentgenerator.
I've developed a couple of those already and it really doesn't take that much time. It is probably going to be faster then trying to recreate the given templates using the built-in document generator of EA.
I'd count on about 10 to 15 days to setup the framework and then about two days per document.
This way you are completely flexible in creating whatever document using any structure required.

Dermot

  • EA Administrator
  • EA User
  • *****
  • Posts: 591
  • Karma: +7/-0
    • View Profile
Re: use of documentation standards
« Reply #2 on: April 10, 2009, 11:46:41 am »
EA's RTF reporting does support generation of documentation that is not directly in the Tree structure of the Project Browser. The main tool for this is to use the Virtual Docments option where specific packages can be assigned to specific templates and generated to one document.  For more info on Virtual Documents see the whitepaper on RTF reporting:
http://www.sparxsystems.com.au/resources/whitepapers/index.html
and
http://www.sparxsystems.com/uml_tool_guide/enterprise_architect_reports/rtfdocuments.html
« Last Edit: April 10, 2009, 11:48:02 am by Dermot »