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.
Subject:RE: API guide sample and/or template From:"Richard L Hamilton" <dick -at- rlhamilton -dot- net> To:<techwr-l -at- lists -dot- techwr-l -dot- com> Date:Mon, 15 Jun 2009 16:20:10 -0600
Leonard,
This question has been bounced around a bit over the years,
so you may find it useful to search the techwr-l site for
some of those discussions.
I don't believe that you will find a general purpose API
sample that will give you what you need. In my view, the
best place to start is with examples of documentation for
APIs using the same programming language and operating
system as you are.
If you post some more information about the particular
programming language and OS, I suspect you can get some
specific suggestions from the list.
Hope that helps,
Richard Hamilton
---------------------------------
XML Press
XML for Technical Communicators http://xmlpress.net
(970) 231-3624
---------------------------------
XML Press
XML for Technical Communicators http://xmlpress.net
(970) 231-3624
> -----Original Message-----
> From: techwr-l-bounces+dick=rlhamilton -dot- net -at- lists -dot- techwr-l -dot- com
> [mailto:techwr-l-bounces+dick=rlhamilton -dot- net -at- lists -dot- techwr-l -dot- co
> m] On Behalf Of Leonard C. Porrello
> Sent: Monday, June 15, 2009 3:37 PM
> To: techwr-l -at- lists -dot- techwr-l -dot- com
> Subject: API guide sample and/or template
>
>
> Does anyone know of a good API and/or sample API and/or API
> template for
> software applications?
>
> Thanks in advance.
>
> Leonard
>
> ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
>
> ComponentOne Doc-To-Help 2009 is your all-in-one authoring
> and publishing
> solution. Author in Doc-To-Help's XML-based editor,
> Microsoft Word or
> HTML and publish to the Web, Help systems or printed manuals.
>http://www.doctohelp.com
>
> Help & Manual 5: The complete help authoring tool for individual
> authors and teams. Professional power, intuitive interface. Write
> once, publish to 8 formats. Multi-user authoring and version
> control! http://www.helpandmanual.com/
>
> ---
> You are currently subscribed to TECHWR-L as dick -at- rlhamilton -dot- net -dot-
>
> To unsubscribe send a blank email to
> techwr-l-unsubscribe -at- lists -dot- techwr-l -dot- com
> or visit
>http://lists.techwr-l.com/mailman/options/techwr-l/dick%40rlha
milton.net
To subscribe, send a blank email to techwr-l-join -at- lists -dot- techwr-l -dot- com
Send administrative questions to admin -at- techwr-l -dot- com -dot- Visit http://www.techwr-l.com/ for more resources and info.
ComponentOne Doc-To-Help 2009 is your all-in-one authoring and publishing
solution. Author in Doc-To-Help's XML-based editor, Microsoft Word or
HTML and publish to the Web, Help systems or printed manuals. http://www.doctohelp.com
Help & Manual 5: The complete help authoring tool for individual
authors and teams. Professional power, intuitive interface. Write
once, publish to 8 formats. Multi-user authoring and version control! http://www.helpandmanual.com/
---
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-
