TechWhirl (TECHWR-L) is a resource for technical writing and technical communications professionals of all experience levels and in all industries to share their experiences and acquire information.
For two decades, technical communicators have turned to TechWhirl to ask and answer questions about the always-changing world of technical communications, such as tools, skills, career paths, methodologies, and emerging industries. The TechWhirl Archives and magazine, created for, by and about technical writers, offer a wealth of knowledge to everyone with an interest in any aspect of technical communications.
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?