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.
Subject:Re: Anyone written for COM Technology? From:Linda Merrifield <MerrLJ -at- CITA -dot- COM> Date:Fri, 2 May 1997 10:48:53 -0500
We are developing an object oriented software system and our design doc
would be the natural place for developers of the interfaces to look.
Here's what we have:
Chapter 1: Application overview (business and system objectives,
including assumptions)
2: Object Oriented Class Diagrams (includes a class dictionary also)
3: Class Definitions (includes all associations, attributes, and
operations).
4: Use Case scenarios
5: Database Design (all entities and diagrams)
6: Prototype User Interface (screen captures of all windows in UI)
7: Key areas for design (interfaces, communications, audit trail, and
other external items)
8: General Application Design (Software Architecture, security, etc.)
9: Development Guidelines (volume and performance requirements, SQA
overview, Doc overview, Programming guidelines, UI guidelines)
You can e-mail me directly if you'd like more information.
Linda Merrifield
Senior Technical Writer
Citation Computer Systems
merrilj -at- cita -dot- com
314-579-7900, ext. 4961
>----------
>From: Colleen Adams[SMTP:PD33 -at- MEDISPAN -dot- COM]
>Sent: Friday, May 02, 1997 9:15 AM
>To: TECHWR-L -at- LISTSERV -dot- OKSTATE -dot- EDU
>Subject: Anyone written for COM Technology?
>
>I've recently been given the task to create documentation for a product
>that uses object technology. Is there anyone out there who has done
>something similar? (Our audience is programmers who will be creating
>the interfaces to these objects.)
>
>I'd appreciate ANY advice I can get (especially regarding content
>organization)! Thanks for the help!
>
>Colleen Adams
>External Documentation Supervisor
>Medi-Span, Inc.
>Indianapolis, IN
>e-mail: colleen_adams -at- medispan -dot- com
>
> TECHWR-L (Technical Communication) List Information: To send a message
>to 2500+ readers, e-mail to TECHWR-L -at- LISTSERV -dot- OKSTATE -dot- EDU -dot- Send commands
> to LISTSERV -at- LISTSERV -dot- OKSTATE -dot- EDU (e.g. HELP or SIGNOFF TECHWR-L).
> Search the archives at http://www.documentation.com/ or search and
>browse the archives at http://listserv.okstate.edu/archives/techwr-l.html
>
TECHWR-L (Technical Communication) List Information: To send a message
to 2500+ readers, e-mail to TECHWR-L -at- LISTSERV -dot- OKSTATE -dot- EDU -dot- Send commands
to LISTSERV -at- LISTSERV -dot- OKSTATE -dot- EDU (e.g. HELP or SIGNOFF TECHWR-L).
Search the archives at http://www.documentation.com/ or search and
browse the archives at http://listserv.okstate.edu/archives/techwr-l.html
