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: Technical Writers Needed for API Doc: Really? From:Andrew Plato <intrepid_es -at- yahoo -dot- com> To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Mon, 14 Jan 2002 10:58:52 -0800 (PST)
I don't think that is too weird. If you have the time and resources to
develop material to help the programmers use the functions, classes, etc.
that's very cool.
However, for the most part I would consider an API manual mostly reference
material.
--- Victoria Camgros <vcamgros -at- persistence -dot- com> wrote:
> At 11:47 PM 1/11/2002 -0800, Andrew Plato wrote:
> ><snip!>
>
> >API guides are mostly raw information
> >intended for a very limited audience that is looking for specific
> >information. API guides don't need to be particularly "friendly." Its
> >just a matter of getting all the functions, classes, and whatever
> >documented.
>
> So, do most of the whirlers agree that API guides==reference material?
>
> When I document an API, I typically develop both a reference (classes,
> methods, basic use) and a "programming guide". The latter covers the API
>
> from the POV of programmer's tasks or problems. It presents conceptual
> material and procedures. The reference is the "quick look up" document
> that
> many on this list have mentioned.
>
> So, is my approach weird, or are you all just calling it something else?
>
> regards,
> V.
>
__________________________________________________
Do You Yahoo!?
Send FREE video emails in Yahoo! Mail! http://promo.yahoo.com/videomail/
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Collect Royalties, Not Rejection Letters! Tell us your rejection story when you
submit your manuscript to iUniverse Nov. 6 -Dec. 15 and get five free copies of
your book. What are you waiting for? http://www.iuniverse.com/media/techwr
---
You are currently subscribed to techwr-l as: archive -at- raycomm -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- raycomm -dot- com
Send administrative questions to ejray -at- raycomm -dot- com -dot- Visit http://www.raycomm.com/techwhirl/ for more resources and info.
