[Author Prev][Author Next][Thread Prev][Thread Next]
[Author Index (this month)][Thread Index (this month)][Top of Archive]

Re: Very old Esoteric terminological query -- APIs

Subject: Re: Very old Esoteric terminological query -- APIs
From: Berk/Devlin <armadill -at- earthlink -dot- net>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Wed, 20 Dec 2000 18:06:51 -0800

On Sat, 21 Oct 2000 11:04:46 -0700 (PDT), Andrew Plato <intrepid_es -at- yahoo -dot- com> wrote: (Yes, well, I've been busy. And am just now catching up on old, old digests)

... This is also the problem with single-sourcing. You lose nuance which in
documents like this is absolutely critical. In the API and tech docs I've
written, I purposedly rejected any attempts to single-source because it reduces my ability as a writer to handle unique and complex concepts.

This is the perfect opportunity to use FrameMaker's conditional text. In this case, I'd have three "conditions": Java, COM and C++. All the text that is identical in all three cases would be conditionalized to "normal". However, if I wanted to use the word "interface" in COM docs but "language" in Java and C++ docs, I would put both those words in as conditional text.

Just be careful about "a" and "an": "an interface" and "a language": remember to conditionalize the article as well as the noun.

--Emily
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
On the web at www.armadillosoft.com *** Armadillo Associates, Inc.
~ Project management, developer relations and
extremely-technical technical documentation that developers find useful.~

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~


^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Develop HTML-based Help with Macromedia Dreamweaver! (STC Discount.)
**NEW DATE/LOCATION!** January 16-17, 2001, New York, NY.
http://www.weisner.com/training/dreamweaver_help.htm or 800-646-9989.

Take XML and Tech Writing courses online! Our instructor-led courses
(4-6 hrs/wk) give you "hands on" experience at your convenience. STC members
get 20% off! http://www.online-learning.com/index.html.
---
You are currently subscribed to techwr-l as: archive -at- raycomm -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- raycomm -dot- com
Send administrative questions to ejray -at- raycomm -dot- com -dot- Visit http://www.raycomm.com/techwhirl/ for more resources and info.

Previous by Author: RE: Convince vs. Persuade (WAS: Displays versus Appears )
Next by Author: Re: Convince vs. Persuade (WAS: Displays versus Appears )
Previous by Thread: Act versus pass (WAS Disp versus App-Which One? ) (slightly OT/ra nt)
Next by Thread: FWD: Venting about reviewing

[Top of Archive] | [Author Index (this month)] | [Thread Index (this month)]

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

Sponsored Ads