RE: SDK documentation

["Steve Hudson" <steve -at- wright -dot- com -dot- au>]

In an obvious contrast to the rest of user doco, do be as techy as possible.
Do include mind-numbing details on file formats, data interchange formats,
data types. Use the jargon that your softies hand you - don't transliterate
their stuff as much as you normally would. Programmers write OK for a
programmer audience. Your job is crack filling and presentation (includes
structure).

Try and make a list of ALL possible program functions and their common
variations and use this as a partial checklist that the SDK is complete.

Steve Hudson , HDK List MVP
Wright Technologies Pty Ltd (Aus)





-----Original Message-----
From: Suzi Magill


I'm working on documentation for a new SDK. I've already read through Gordon
and Gordon's book on how to document them. I was wondering if anyone out
there has any pointers, warnings, or best practices they would like to share
with me?


^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Collect Royalties, Not Rejection Letters! Tell us your rejection story when you 
submit your manuscript to iUniverse Nov. 6 -Dec. 15 and get five free copies of 
your book. What are you waiting for? http://www.iuniverse.com/media/techwr

Have you looked at the new content on TECHWR-L lately?
See http://www.raycomm.com/techwhirl/ and check it out.

---
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.