API Documentation

Subject: API Documentation
From: Eeshita Grover <eeshita -at- ishoni -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Tue, 31 Oct 2000 09:39:01 -0800

Hi there:
I am working on an API Manual, which requires me to go into all the .c files
and read through the code.
While doing this I notice that the SW engineers use a lot of numbers, e.g. 3
bits, 16 bits etc.
I am wondering when should I spell the numbers and when not spell them out.

Comments/suggestions are absolutely needed.

Eeshita Grover
Technical Writer
ishoni Networks

Learn how to develop HTML-based Help with Macromedia Dreamweaver!
Dec. 7-8, 2000, Orlando, FL -- $100 discount for STC members.
http://www.weisner.com/training/dreamweaver_help.htm or 800-646-9989.

Your web site localized into 32 languages? Maybe not now, but sooner than
you think. Download ForeignExchange's FREE paper, "3 steps to successful
translation management" at http://www.fxtrans.com/3steps.html?tw.

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: usage: when not if-then, how to use 'then'
Next by Author: RE: How to Print a List of Files (ASAP)!
Previous by Thread: RE. Preposition to use when referring to window, page, or tab?
Next by Thread: RE: API Documentation

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

Sponsored Ads