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.
Subject:RE: Riddle Me This From:"Geoff Lane" <geoff -at- gjctech -dot- co -dot- uk> To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Tue, 3 Jul 2001 23:07:22 +0100
Bruce Byfield wrote:
>
> I don't think that anyone would bother inventing their own
> names in API
> documentation. Would they?
---
Emphatically yes, I "invent" my own names. When I write API docs, I tend to
write my own examples -- SMEs are usually far too busy to worry about such
trivia. If you don't follow the naming conventions of the programming
language for your variables, constants, and so on, your docs get less
respect from the programming community (your target audience).
Just my opinion,
Geoff Lane
Cornwall, UK
geoff -at- gjctech -dot- co -dot- uk
*** Deva(tm) Tools for Dreamweaver and Deva(tm) Search ***
Build Contents, Indexes, and Search for Web Sites and Help Systems
Available now at http://www.devahelp.com or info -at- devahelp -dot- com
TECH*COMM 2001 Conference, July 15-18 in Washington, DC
The Help Technology Conference, August 21-24 in Boston, MA
Details and online registration at http://www.SolutionsEvents.com
---
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.
