For your review, I've uploaded the 1st Draft of the C API Reference Guide for AOLserver 4.0.
The URL is http://www.aolserver.com/40drafts/capi
Actions for reviewers:
1) Focus on the new functions (the 2nd item on the top level page)
2) Review for technical accuracy.
3) Provide info for Description section. Simple functions can probably get away with a repeat of the Overview sentence, but ideally, the Description should include some usage info, tips on when to call (or when NOT to call) the function, and other techniques, etc.
4) Provide code examples, if possible, so I can include an "Example" section on the page.
5) Don't worry about Related Functions. I'll fill them in as we go.
6) Comment on any major navigation or usability issues.
Suggested Process:
1) Every individual function page has a footer that includes a last modification timestamp and my email address. Send feedback by clicking my email link on any page (the Subject will automatically be populated with the function name).
2) For general feedback, send email to me at [EMAIL PROTECTED]
3) Not sure how many of you will reply, but to avoid chaos, it might be good for some of you to volunteer as 'primary reviewers' and carve out an area to review (for example, all the Conn* functions, or letters A-B).
4) We'll adapt the process as needed.
Things to note:
1) I've created 2 navigational tracks for the info. The upper track (gray) allows you to visit ALL functions in alpha order. The other track (light blue) lets you visit only the new functions.
2) Compare the 40draft location with the existing C API here:
http://www.aolserver.com/docs/devel/c/api
3) When do I need feedback? Well, "the sooner the better." Version 4.0 will be released before the docs are complete, so the docs are in catch-up mode right out of the gate. Let's see what we can accomplish by pulling together to minimize that gap.
Thanks in advance for your help with our Doc Revision project. I look forward to working with all of you in the weeks ahead and incorporating your feedback to improve the AOLserver doc set.
Regards,
Daniel Gilly
Principle Technical Writer
AOL Web Services & Publishing Team
-- AOLserver - http://www.aolserver.com/
To Remove yourself from this list, simply send an email to <[EMAIL PROTECTED]> with the body of "SIGNOFF AOLSERVER" in the email message. You can leave the Subject: field of your email blank.
