Back by popular demand!

APIs and SDKs: Breaking Into and Succeeding in a Specialty Market

The goals of this workshop are to:

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 documentationfor APIs/SDKs from the source code, a “single source of truth.” Be able to describe why this approach is preferred by manydevelopers. 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 an API/SDK sample that you can show to potential clients or employers.

Computer requirements

You are asked to bring a laptop with you for this workshop. You will need to install some software on your laptop, all software is provided on a CD.

Please remember to bring a laptop that allows you to install software. Many corporate IT departments block the software installation features on their employees’ computers.

Discussion of APIs and SDKs

What are APIs and SDKs? How are these similar and different?

Who uses APIs and SDKs?

What are the typical documentation deliverables? What information should you provide to users?

What are the benefits and drawbacks to working in this area for technical writers?

How much do you have to read software code? What information can you get from the code and what can’t you get from the code?

Doxygen discussion and demo and hands-on exercises

Students will complete these tasks:

Inserting typical reference information into the source files, generating the online help, and viewing the output.

Inserting conceptual information into the source files, generating the online help, and viewing the output.

MathWorks

A little about Ed

Ed Marshall is an independent consultant technical writer and the sole proprietor of Marshall Documentation Consulting, with over 25 years in technical writing. He specializes in technical documentation for developers including API (application programming interfaces), SDK (software developer’s kits), Web Services products, etc.

Over his career, Ed has developed expertise in using tools to “let the computer do the work,” such as advanced tools for editing files, comparing files, and searching / replacing text.

He has presented many talks at local STC chapters, the STC Conferences/ Technical Summits, the WritersUA Conferences, the DocTrain Conferences, and other professional conferences, including the TEKOM trade show in Germany (October 2012), at their invitation.