Re: large-scale CORBA deployment

[Chris Hamilton <chamilton -at- GR -dot- COM>]

Julian--

I'd start with the API references first. That allows you to cut your teeth on
something relatively easy to document while you learn the rest of the product.
You can look in the archives for information about structuring API references;
I know it's come up before. It sounds as if you're going to need an
administration guide and at least one developer's guide.

You may also have to go into ORBs and what they are a little bit. CORBA's
something that isn't well known by tons of people. In fact, I'd work on
learning about ORBs while you're starting the API references, if you don't
already know about them. If you come up with a good reference, please let me
know. I'm interested in finding one.

And get ready to increase your salary, 'cause CORBA seems to be an
up-and-coming thing that'll look just wonderful on your resume.

Chris

Julian Tudorache wrote:

> Hi.
>
> I just got a gig documenting a large-scale CORBA deployment in a
> financial organization.
> I need to produce technical reference material that covers APIs and
> other interface-specific calls. The audience comprises developers and
> business analysts. They need to know how to write code that talks to the
> new system.
>
> The front-end to the system is written using Java script. The primary
> users are brokers and administrative staff. An online user guide and a
> quick reference card are required.
>
> Any one out there tackle something like this before? Ideas or
> strategies?
>
> thanks,
> julian.
>