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.
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)."
__________________________
Bobbi:
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
themselves.
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.
