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.
If you have not done this before, you might take a look at Document! X from
Innovasys. Depending on the language used to create these COM objects,
Document! X could be a help to you. If the COM objects are written in Visual
Basic, Document! X is a good fit. At the very least, the examples available
on the Innovasys site could be useful to give you some ideas of what
direction to go in.
System wide procedures and functions get you into other areas. You could
benefit from creating object model diagrams (using something like Visio),
and perhaps also from tools already available because the developers use
them. Is it a Rational shop? Does the system involve a database? If so,
which one? Procedural documentation in itself is endless, and hinges on the
state of development at any given moment. Often procedure documentation is
the most short lived of all technical documentation. And as for function, I
suppose you mean functional specification? If this has not already been
documented for a system in production, then you might want to ask some
questions of the folks who built it. Functional specification tends to be
written after the requirements phase but before the development phase.
From: Andrew T. Brooke [mailto:abrooke -at- pathcom -dot- com]
Sent: Friday, September 20, 2002 3:26 PM
Subject: Documenting COM objects
I have the following project to do next month:
"Design, develop, and update required technical documentation of COM
objects, procedures and functions of the XYZ system" (name changed to
protect the innocent!)
I think I have a fair idea of what COM objects are - here's one description
I found, which may apply:
Component Object Model (COM)
A model for binary code developed by Microsoft. The Component Object
Model (COM) enables programmers to develop objects that can be accessed by
any COM-compliant application. Both OLE and ActiveX are based on COM.
I've documented API services in the past and think this may be similar. Is
there anyone who has document COM objects who can offer me any practical
abrooke -at- pathcom -dot- com
FrameMaker-to-PDF TimeSavers Assistants let you enhance & automate navigation
in PDF doc sets (chapter tabs, next/prev chapter/pg, bookmarks, popup menus);
create interactive PDF forms, rollover popups; presentations: http://www.microtype.com
Experience RoboHelp X3! This new RoboHelp release combines single sourcing,
print-quality documentation, conditional text and much more, into the most
monumental release of RoboHelp ever! http://www.ehelp.com/techwr-l
You are currently subscribed to techwr-l as:
archive -at- raycomm -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- raycomm -dot- com
Send administrative questions to ejray -at- raycomm -dot- com -dot- Visit http://www.raycomm.com/techwhirl/ for more resources and info.