Book a Demo

Author Topic: Generating complex RTF documents  (Read 2874 times)

specious

  • EA Novice
  • *
  • Posts: 4
  • Karma: +0/-0
    • View Profile
Generating complex RTF documents
« on: March 29, 2007, 03:42:55 am »
I'm working for a client who is shooting for CMMI3 accreditation. As a result we have to produce reams of documents that nobody reads, to get a tick in the box to pass through the various gateways in the process.

I dislike producing documents as much as the next person, but if I have to do it then I want to generate them from the model. Then I can get on with the real business of software design.

Here's an example. A document needs to have a list of stakeholders, a business context, some business process models, and a list of requirements. In between these is some boilerplate text that rarely changes. Each of these sections needs a different EA template, and I can't generate the master document at all.

As far as I can see, there doesn't seem to be any way to produce multiple sections in a document generated by EA, without generating all the subsections individually and then stitching them together in a master document by hand afterwards. At first I though that Virtual Documents might be the answer, but you can only specify a single template for the whole virtual document at generation time. If you could associate the template at the package level in the virtual document, it would at least be an improvement. Some kind of conditional or filter processing would be good too.

The current template editor only allows you to iterate over the model once. This is too restrictive unless your document happens to have the same structure as your model. As the model is where the real value of EA lies, I wouldn't want to bend the model out of shape just to fit the documentation...

Has anyone else experienced this problem, and are there any work-arounds? In an ideal world, I want to be able to set up and save some combination of templates, generation options, and target file in a virtual document as part of my project. Once that is done, I could regenerate the document whenever the model changed.

«Midnight»

  • EA Guru
  • *****
  • Posts: 5651
  • Karma: +0/-0
  • That nice Mister Grey
    • View Profile
Re: Generating complex RTF documents
« Reply #1 on: March 29, 2007, 03:53:38 am »
Quite some time ago I wrote a custom documentation generator using the API. I opened both EA and MS Word as COM clients. Filters and output formatting were largely under my control.

This dates back to the dark days before EA had its "new" rtf generator; there were only canned templates then. However, the interface is still there, and continues to work.

The work was considerable, but the results were excellent, and likely could not have been produced faster by other means. Nor did I generalize the tool to 'any' document type.

I do not advocate this solution for the weak of heart, or for those in crunch mode. But, it might solve larger problems where you will have to generate specific types of documents several times.

David
No, you can't have it!