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.
there have been only positive responses (a single one <g>), so I will start to
discuss one point of my check list at a time.
To repeat it: This checklist is intended to define how, you as a writer of
online documentation, will interact with the programmers of your project.
Here is the fist installment:
1) Get the style guides for your platform:
PLATFORM-SPECIFIC STYLE GUIDES
1. Apple Computer, Inc. Macintosh Human Interface Guidelines.
Reading, MA: Addison-Wesley Publishing Co., 1992. ISBN 0-201-
62216-5. There is an interactive animated companion CD-ROM to
these Mac guidelines called "Making it Macintosh", Addison-Wesley,
1993. ISBN 0-201-62626-8.
2. Commodore-Amiga, Inc. Amiga User Interface Style Guide.
Reading, Mass.: Addison-Wesley, 1991. ISBN 0-201-57757-7.
3. GO Corporation. PenPoint User Interface Design Reference.
Reading, MA: Addison-Wesley, 1992. ISBN 0-201-60858-8.
4. Hewlett-Packard, IBM, Sunsoft Inc. & USL. Common Desktop
Environment: Functional Specification (Preliminary Draft). X/Open
Company Ltd., 1993. ISBN 1-85912-001-6. Available via ftp from ftp
XOPEN.CO.UK/pub/cdespec1/cde1_ps.Z
5. IBM. Object-Oriented Interface Design: IBM Common User Access
Guidelines. Carmel, Indiana: Que, 1992. ISBN 1-56529-170-0. [There
is a CD-ROM containing many IBM manuals and guide lines. It is
much cheaper than the several manuals you might need, e.g. for
OS/2 developement. AvO]
6. James Martin, Kathleen Kavanagh Chapman & Joe Leben. Systems
Application Architecture: Common User Access. Englewood Cliffs,
NJ: Prentice-Hall, 1991. ISBN 0-13-785023-9.
7. Microsoft Corporation. The GUI Guide: International
Terminology for the Windows Interface. Redmond, WA: Microsoft
Press, 1993. ISBN 1-55615-538-7. [You can get updated versions of
these glossaries electronically, see below. AvO]
8. Microsoft Corporation. The Windows Interface: An Application
Design Guide. Redmond, WA: Microsoft Press, 1992. ISBN 1-55615-
384-8.
9. Open Software Foundation. OSF/Motif Style Guide. Englewood
Cliffs, NJ: Prentice Hall, 1993. ISBN 0-13-643123-2.
10. NeXT Computer, Inc. NeXTSTEP User Interface Guidelines
(Release 3). Reading, Mass.: Addison-Wesley Publishing, 1992. ISBN
0-201-63250-0.
11. Sun Microsystems, Inc. OPEN LOOK Graphical User Interface
Application Style Guidelines. Reading, Mass.: Addison-Wesley,
1989. ISBN 0-201-52364-7.
12. Sun Microsystems, Inc. OPEN LOOK Graphical User Interface
Functional Specification. Reading, Mass.: Addison-Wesley, 1989.
ISBN 0-201-52365-5.
(Thanks to Gregory Keith <GKeith -at- delrina -dot- com> for this list.)
Any additions or clarifications for this?
If you wish to receive the check list in its present unfinished form, send an
empty message to onlchecklist -at- twh -dot- msn -dot- sub -dot- org
If you wish to join the Forum 95 mailing list, sent a message to
listserv -at- twh -dot- msn -dot- sub -dot- org -dot- the message should contain one or more of the
following lines:
