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.

Requirement: Laptop. You must have adequate privileges to be able to install open-source software on the laptop.

Workshop Outline

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

Class size is limited for this his intense one-day training, so be sure to sign up early. Breakfast and lunch will be provided.

Speaker Bio:

Ed Marshall is an independent contractor providing documentation and training. Ed has owned and operated Marshall Documentation Consulting for over 4 years.
 
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.