API SDK Writers, Programming Writers

Add a Comment

8 Comments

Comment by Rajeev Jain on June 23, 2008 at 12:01am

Hi Jay, Welcome to APIWriters. I have compiled some relevant links in yahoo group APIWriters and also at my blog:

http://api-writing.blogspot.com

Hope this could be of some help to you.

Comment by Jay Maechtlen on June 22, 2008 at 4:52pm

Hello-
As a new member, I've been techwriting for a long time.
I haven't done API writing yet, though I've documented some software packages and such.
This should be a good learning experience for me...

Comment by Wilma Zamboli on May 19, 2008 at 11:48am

Hi to everyone, I'm an "information" developer officially since 1999 and I was a "software" developer since 1980.
My activity now vary form online help, training, hw&sw installation manuals and some time APIs too.

Comment by Neal Dench on May 14, 2008 at 5:08am

Hi, I joined a couple of days ago, so thought I'd better give a brief introduction.

I have 17 years experience as a technical author, much of which has been spent documenting APIs. I currently manage the documentation for a number of API Toolkits, as well as an XML Schema. I work as a lone technical author, and for the most part developers write the API documentation themselves within source code comments: my main responsibility is to add contextual value to the API documentation by writing accompanying functional documentation, as well as reviewing and editing the developer's API documentation, and publishing the whole lot as a cohesive documentation set.

I currently use unstructured FrameMaker for writing, and publish via FM's Save as HTML functionality, and a suite of homegrown Perl scripts. We have a long term aim of adopting DITA to overcome the many maintenance headaches that such a publication scheme raises, though as a lone author, this is an incredibly slow process!

Comment by Rajeev Jain on May 14, 2008 at 12:48am

Hi Chris , Bernice

Welcome Aboard! Nice to know see professionals like you giving your time.

Comment by Chris Despopoulos on May 13, 2008 at 12:57pm

Hi... I just joined, so here's my intro. Name is Chris Despopoulos. I currently work for EMC documenting APIs for a development platform. It's lots of fun, I've really gotten my head around Java, and get to write tools to streamline the process.

Prior to this job I did lots of plugin development for FrameMaker. I learned that API by documenting and supporting it for a couple of years. I passed out my Maker tools under the name of CudSpan...

I'm starting to believe that API writing is the future... The GUI is supposed to be self-documenting, isn't it?

Comment by Bernice Kieffer on May 13, 2008 at 11:22am

Hi All:

Just joined and was asked to introduce myself so here goes:

My name is Bernice Kieffer and I have been a technical writer for approximately 20 years or so. I am currently working in the EDA (Electronic Design Automation) industry. As part of my current duties, I am ofter called upon to document the API's in our tools.

Comment by Rajeev Jain on April 11, 2008 at 7:42am

Brief Intro