RE: API - Suggestions on Document

Subject: RE: API - Suggestions on Document
From: "Margaret Cekis" <Margaret -dot- Cekis -at- comcast -dot- net>
To: "'Roberta Hennessey'" <rahennessey -at- gmail -dot- com>, "'tech writer tech writer'" <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Thu, 19 Apr 2012 23:59:41 -0400

Roberta Hennessey asked for Suggestions on an API Document:
"I have been tasked to write a new version of existing API docs.
The audience for this new document is both technical and very
non-technical. The API is a .NET web services (asmx files)."
An APi document is, in essence, just a catalog of all the features, options,
and parameters in a computer application. The idea is to set it up in
easy-to use reference tables, with a few explanations of the acceptable
input formats, some examples of how to read the reference tables, and some
guidance on which type of information is in which table. They usually have
very few diagrams.

Just make sure that everything is well-labeled with good navigation, and I
don't think you have to be particularly inventive, or worry about a very
non-technical audience using it. If people can understand how to use the
program well enough to want to customize it, they probably have enough
smarts to use a typical AP doc, and are motivated to do so. The others would
just ask a friend for help, and not attempt to do anything complex
Margaret Cekis, Johns Creek, GA

Create and publish documentation through multiple channels with Doc-To-Help. Choose your authoring formats and get any output you may need.

Try Doc-To-Help, now with MS SharePoint integration, free for 30-days.


You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-

To unsubscribe send a blank email to
techwr-l-leave -at- lists -dot- techwr-l -dot- com

Send administrative questions to admin -at- techwr-l -dot- com -dot- Visit for more resources and info.

Looking for articles on Technical Communications? Head over to our online magazine at

Looking for the archived Techwr-l email discussions? Search our public email archives @

API - Suggestions on Document: From: Roberta Hennessey

Previous by Author: RE: Are "Easy Buttons" important in a Windows software installer?
Next by Author: Re: What's in a name?
Previous by Thread: Re: API - Suggestions on Document
Next by Thread: RE: API - Suggestions on Document

What this post helpful? Share it with friends and colleagues:

Sponsored Ads