m API-Writing / API-Documentation: Resources / Links for API Documentation

Wednesday, March 12, 2008

Resources / Links for API Documentation

API Writer : Wikipedia
API Documentation - Trends and Opportunities
http://www.stc-india.org/conferences/2004/PprPrest/Conf_Rajeev.htm

Developing your First API Guide, by Rajeev Jain
http://www.stc-india.org/conferences/2006/agenda_web.htm

API documentation: Wikipedia Definition
http://en.wikipedia.org/wiki/API_documentation

How To Write Technical Documentation For APIs
http://www.ihearttechnicalwriting.com/content-management/how-to-write-technical-documentation-for-apis/4268/
FrameScript Tutorials
http://www.frameexpert.com/tutorials/index.htm

What Programmers Really Want-Manuel Gordon
http://www.gordonandgordon.com/downloads/What-Programmers-Really-Want.doc

What are APIs and SDKs by Susan W Gallagher
http://members.cox.net/susanwg/susanwg/api.html

Source Code Documentation using Doxygen, by Ruchi Kak
http://www.stc-india.org/conferences/2004/SessionInfo.htm

API Writing Tips (Surface level tips for good API writing)
http://www.dustindiaz.com/api-writing-tips/

An Introduction to API Documentation, by Akash Dubey
http://www.stc-india.org/activities/learningsessions/BloreSessions/october/API.PPT

Creating a Linux Manual (man) Page-Subhasish Ghosh
http://linux.omnipotent.net/article.php?article_id=12493

Doxygen
http://www.stack.nl/~dimitri/doxygen/download.html#latestsrc

How to document VB6, VB.NET and ASP.NET projects
http://www.vbdocman.com/

txt2man-Txt2man converts flat ASCII text to man page format.
http://mvertes.free.fr/

Javadoc Tool: To generating API documentation in HTML format
http://java.sun.com/j2se/javadoc/index.jsp

Writing for Programmers
http://www.stc-northbay.org/newsletters/aug00.pdf

Yesterday API was just another acronym; today I have to document one! by Susan
http://members.cox.net/susanwg/susanwg/api.html

How to Write Doc Comments for the Javadoc Tool?
http://java.sun.com/j2se/javadoc/writingdoccomments/

Working with XML: Table of Contents
http://industry.ebi.ac.uk/~senger/xml/docs/tutorial/TOC.html

Labels: , , , ,

0 Comments:

Post a Comment

<< Home