Specialized formatting.

["John Posada (work account)" <posada -at- FAXSAV -dot- COM>]

Hey, guys...

I'm involved in a project that involved documenting a hundred or so
Application Program Interfaces (APIs).

I'd like opinions on what type of formatting you've applied or what you
would have done differently when you've creating the same type of
specialized information and if anyone knows of either web links or books
on this particular subject.

I've gotten it down to 6 sections for each one.  Each API may not
include all the sections (i.e., there may not be any notes for a
particular entry:

Syntax: an example might be fsInit(HTASK hTask ,LPCSTR pszId, DWORD
dwFlags)
Description:
Parameters:
Code Example:
Return:
Note:

All of the hundred except to maybe 5-6 fit on page page and I'm starting
a new page with each one.
I place the code example inside a frame using Arial to avoid alignment
adjustment. problems

Aside from the preferences that everyone may have that don't affect
meaning, are there any hints or tricks that anyone has used to make an
unusually effective document from the programmer's standpoint.

I'd even settle for any publications that documented this type of
information in a way that you were impressed with that I could use for
hints.

--
John Posada
The world's premier Internet fax service company: The FaxSav Global
Network
-work http://www.faxsav.com     -personal http://www.tdandw.com
-work mailto:posada -at- faxsav -dot- com  -personal mailto:john -at- tdandw -dot- com
-work phone: 908-906-2000 X2296 -home phone: 732-291-7811
My opinions are mine, and neither you nor my company can take credit for
them.


Posts: mailto:techwr-l -at- listserv -dot- okstate -dot- edu
Commands: mailto:listserv -at- listserv -dot- okstate -dot- edu (e.g. SIGNOFF TECHWR-L)
Archives: http://listserv.okstate.edu/archives/techwr-l.html,
	http://www.documentation.com/, or http://www.dejanews.com/
Subjects: JOB:, QUESTION:, SUMMARY:, ANNOUNCE:, or none of these.