RE: SDK documentation

[Suzi Magill <SMagill -at- adaytum -dot- com>]

Thanks for this. I am in the process of joining the API/SDK group on Yahoo.
As for the Gordon and Gordon book, I have mixed reviews about it:

1. I paid $80 for a bound PowerPoint demonstration. (It also took 2 weeks to
get here and there was no way to specify overnight or next day shipping-
something I would have gladly paid extra for given the urgency of my
project...)
2. The info in the book was helpful to a degree, but I dont think it lived
up to its hype. 
3. While nothing beats an actual seminar, this certainly could have been
made more useful by Gordon and Gordon. Maybe Im too demanding, but a sample
SDK doc set would be helpful, or a template of some sort? 

I would not recommond paying the $80 unless they beef it up with more
information than just slides. Some of which should have been omitted because
they were meant for the seminar. 

BUT, since there is minimal documentation available on SDKs, I had to take
what I could get. I have a feeling that the actual seminar was very
informative and valuable, unfortunately, my company was less than thrilled
about the expense right now. 

Anyway, thank you for your pointers Lydia!

-----Original Message-----
From: Lydia Wong [mailto:lydiaw -at- fpoint -dot- com]
Sent: Tuesday, November 20, 2001 1:50 PM
To: Suzi Magill; TECHWR-L
Subject: RE: SDK documentation


Hi Suzi,

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

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.