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.
Looks as if I'm in the minority here, but I almost exclusively doc
'underlying structure' i.e. Objects in C++/Rational Rose models. I
work in the 'architecture' department of my software development
company, and we (they) write object components that are utilized by
other programmers (the 'architecture' of the software). This means
that I have to have a pretty firm understanding of object oriented
software construction, the Unified Modeling Language, and how COM
works. Exciting, eh?
I'd strongly recommend learning the underlying structure of software -
there's a big market for those of us who are able to write this stuff.
Sam Caplan
______________________________ Reply Separator _________________________________
Subject: Documenting software
Author: Katherin King <kking -at- BROOKTROUT -dot- COM> at internet
Date: 6/30/98 3:42 PM
For those of you who document software applications, how much of what
you do is documenting the GUI and how much of it is documenting the
underlying structure, the means by which the GUI is implemented? In
other words, how important is it, do you think, for tech writers to
understand the inner workings of the software?
Kathy Stanzler
Technical Writer
Brooktrout Technology Inc.
Southborough, MA
(508) 786-9182
kking -at- brooktrout -dot- com
