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.
This is my first posting to this list. I have been following the thread of
discussion RE: documentation of OOP applications. It appears to me that
there are two basic issues here. The first is an understanding of the issues
specific to OOP itself. The second relates to the proper tech writing
methodologies to be applied to clear, concise and accurate documentation of
the applications developed through OOP.
On the first point, I just wanted to recommend to anyone new to writing on
this particular issue what I feel to be one of the best primers on OO. It's
called "Object Oriented Program Design" by Mark Mullin. It was first
published by Addison-Wesley in 1989 (yes, I know, three computer generations
ago). It starts out by detailing the strategies involved in OOP and then
allows you to go as deeply as you wish in understanding the complexities of
the application design process. At each step, examples are given of code in C++.
Software documentation, preparation of tutorial materials and similar
writing is an area that I am interested in getting a start in. Thus, I have
been following this thread with great interest.
Shalom,
Shmuel Ben-Artzi
Netanya, Israel
sba -at- netmedia -dot- net -dot- il
TECHWR-L List Information
To send a message about technical communication to 2500+ list readers,
E-mail to TECHWR-L -at- LISTSERV -dot- OKSTATE -dot- EDU -dot- Send administrative commands
ALL other questions or problems concerning the list
should go to the listowner, Eric Ray, at ejray -at- ionet -dot- net -dot-