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.
Documenting an OO application's user interface that exposes the OO stuff
Subject:Documenting an OO application's user interface that exposes the OO stuff From:cclunas -at- pria -dot- com To:techwr-l -at- lists -dot- raycomm -dot- com Date:Wed, 1 Dec 1999 15:41:25 -0500
Has anyone had experience documenting an object-oriented application that
exposes the underlying objects, types, instances, etc. right in the user
interface, and makes the user work with them? If so, how did you describe the
objects, types, instances, etc. without also providing a crash course in OO
concepts?
I'm not talking about an API guide here; the application will have a separate
API guide.
The problem is in coming up with terminology in the user guide that non-OO-aware
users can readily understand that won't conflict with strict OO terminology.
The application will have a wide range of users: some who know OO, some who
don't.
