FW: API documentation with references to Javadocs documentation

[Sean Pollock]

Ron,
No two API docs are exactly the same, but usually they're pretty simple. It helps if you've done a little programming or scripting. Here are a couple sites to get you going:http://api-writing.blogspot.com/
http://java.sun.com/j2se/javadoc/
http://qooxdoo.org/documentation/0.7/how_to_write_api_documentation
 
Hope this helps,
 
Sean Pollock
 
Siemens PLM Software



> To: framers at lists.frameusers.com> From: ronsmiller at comcast.net> Subject: API documentation with references to Javadocs documentation> Date: Tue, 13 May 2008 10:46:53 -0400> > Hi:> I have a JavaDocs reference. My client has asked me to write an API > document in Frame with references to the JavaDocs documentation. The > goal of the document is to provide further explanation and examples > along with a context for usage beyond what is provided in the > JavaDocs. In addition, the client wants to provide documentation on > how to use Web Services instead of a Java object.> > I've been a tech writer for a long time, but I'm in new territory > here. I'm wondering if there is a standard way to approach this (or > if we are covering new ground). Can anyone point me to resources to > get me started.> > One thing I'm having trouble with is deciding how much JavaDocs > information I should include in the Frame reference and how much I > should simply provide links or references to. If anyone has any ideas > on how I can started, I would greatly appreciate it.> > Thanks,> Ron> > Ron Miller> Freelance Technical Writing Since 1988> > email: ronsmiller at ronsmiller.com> blog: http://byronmiller.typepad.com> web: http://www.ronsmiller.com> > > > > _______________________________________________> > > You are currently subscribed to Framers as spolloc1 at hotmail.com.> > Send list messages to framers at lists.frameusers.com.> > To unsubscribe send a blank email to > framers-unsubscribe at lists.frameusers.com> or visit http://lists.frameusers.com/mailman/options/framers/spolloc1%40hotmail.com> > Send administrative questions to listadmin at frameusers.com. Visit> http://www.frameusers.com/ for more resources and info.
_________________________________________________________________
Stay in touch when you're away with Windows Live Messenger.
http://www.windowslive.com/messenger/overview.html?ocid=TXT_TAGLM_WL_Refresh_messenger_052008