Re: Documenting Object Oriented Applications

Subject: Re: Documenting Object Oriented Applications
From: Shmuel Ben-Artzi <sba -at- NETMEDIA -dot- NET -dot- IL>
Date: Sat, 27 Jul 1996 01:04:24 +0200


I understand the principles of OOP from an applications development point of
view, but your comprehensive analysis of the documentation procedure is
quite instructive. If I understand you correctly, only context-sensitive
online (help-type) documentation can provide the degree of portability and
adaptabiliy necessary to properly document an OO application, correct? And
would this be true whether writing for the developer or for the end user?
How about tutorials and collateral documentation?

Can you recommend a good reference volume on the design and creation of
context-sensitive documentation?

Thanks and Shalom,

Shmuel Ben-Artzi
Data Services Manager, Ulpan Akiva
Netanya, Israel
sba -at- netmedia -dot- net -dot- il

>Being that the functionality is portable, the documentation must also be
>portable. Therefore, the documentation for the text applet should keep
>focus on text construction, formatting, and modification and not be
>concerned with graphics, page layout, file format, and so forth (the
>graphics and document handler applet documentation addresses these).

>Mike Wing

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-

Previous by Author: Re: Online vs. Hardcopy documetation
Next by Author: Re: Tech Writer as Webmaster
Previous by Thread: Re: Documenting Object Oriented Applications
Next by Thread: Re: Documenting Object Oriented Applications

What this post helpful? Share it with friends and colleagues:

Sponsored Ads