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.
You asked for information about SDK documentation. I'm glad you found the
Gordon and Gordon workbook. It is excellent.
It's hard to know where to start in terms of other "pointers, warnings, or
best practices." I'd like to suggest two things to you:
1) Search the archives for TechWr-L. There have been several discussions
with great responses concerning the ins and outs of API and SDK writing.
Search the archives using those terms/acronyms, and I think you'll find some
very valuable information.
2) Join the API/SDK tech writers group. You can join the group at http://groups.yahoo.com/group/nettechwriters. We have a good section of
bookmarks (links) to take you to some other resources. Also, in the future
as you have more questions, I think you'll find it a knowledgeable and
helpful group (along with the folks here on TechWr-L).
Good luck, and I hope this helps,
Lydia
-----------------------------------
Lydia Wong
Technical Writer
FarPoint Technologies, Inc.
www.fpoint.com
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
Your monthly sponsorship message here reaches more than
5000 technical writers, providing 2,500,000+ monthly impressions.
Contact Eric (ejray -at- raycomm -dot- com) for details and availability.
---
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.
