APIs - SDKs: Breaking Into and Succeeding in a Specialty Market Workshop Outline

The Carolina Chapter is proud to offer a full day API-SDK Workshop presented by Ed Marshall of Marshall Documentation Consulting.

Why learn how to document APIs?

We have many software writers in the Research Triangle Park area, and all of them are familiar with documenting the graphical user interfaces (GUIs) that allow people to interact with software programs. Far fewer have documented the application programming interfaces (APIs) that allow software programs to interact with other software programs—and fewer still know how to do it well.

Note: Registration closes on Wednesday, April 13 at 5:30 p.m.

• When: Saturday, April 16, 2011, 8:30 AM - 5:00 PM (ET)
• Where: Tekelec, 5200 Paramount Parkway, Morrisville, NC

Breakfast and lunch will be provided.



This full-day workshop has the following goals:

• Learn what APIs and SDKs are, who uses them, and why.
• Learn what typical documentation deliverables are for these products.
• Learn two common methodologies for producing documentation for APIs/SDKs from the source code, a “single source of truth.” Be able to describe why this approach is preferred by many developers. Practice using two common tools for producing documentation from the source code, Doxygen and Javadoc.
• Learn recommended sources of training to get the skills needed for this area.
• Create two API samples (C and Java) that you can show to potential clients or employers.

Schedule:

• Introductions
• Review course goals
• Discussion of APIs and SDKs
• Doxygen discussion and demo
• Setting up Doxygen exercises
• Doxygen exercises
• Lunch
• Doxygen exercises review
• Javadoc discussion and demo
• Setting up Javadoc exercises and Sun's NetBeans IDE
• Javadoc exercises
• Javadoc exercises review
• Additional training for API / SDK writers
• Q&A
• Closing

Location

Tekelec
5200 Paramount Parkway
Morrisville, NC

Registration

STC Carolina members: $150
Not a member?Join today...
All others: $250

Presenter

Marshall Documentation Consulting has been owned and operated by Ed Marshall for over 4 years. Ed is an independent contractor providing documentation and training.

Ed has over 22 years experience writing and producing printed and online documentation for various audiences. Ed has worked in development environments ranging from large central groups to start-ups to being a sole US-based writer, with a project team based in Europe.

---