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

Presented by API/SDK documentation expert Ed Marshall, Marshall Documentation Consulting in Boston

Cost: $195 per person (includes breakfast and lunch)

Since the early 1990s, the demand for application programming interface (API) and software development kit (SDK) documentation for developers has grown rapidly and shows no signs of declining. At the same time, there’s a shortage of writers in this niche. They enjoy a steady income, higher hourly rates, and often the luxury of telecommuting.

Contrary to some perceptions, API/SDK writers are typically not computer programmers. They're technical writers who are detail oriented, who know how to glean information for documentation by reading developers' code and communicating well with developers. Although having familiarity with one or more programming languages is important, technical writers can leverage skills they already have to add value to API/SDK documentation, such as the ability to organize information, recognizing where important gaps in the content exist, and providing consistency in content and use of terms.

How do you enter and succeed in this market? Join Ed Marshall, a nationally recognized expert in API/SDK writing, for an introduction to this world of writing documentation for software developers on Saturday, August 28. During this all-day, hands-on workshop, you will learn:

• What APIs and SDKs are and the similarities and differences between them.
• Who uses APIs and SDKs and why.
• The benefits and drawbacks of API/SDK writing.
• How to gather information, primarily by reading the software code. For example, which files do you read? Which programming keywords are important?
• What information you can get from the source code and what to look for. What information you can’t get from reading the source code.
• Hands-on exercises using Doxygen and Javadoc to generate typical online documentation from a set of C and Java source code files.
• The skills you need to succeed, including common programming concepts, software applications used for creating these documents, and tips for adding value based on your technical knowledge.
• Where to find training.

Ed will also show examples of typical API/SDK documents and demonstrate the software tools used to generate documentation from the developers’ source code. He will allocate ample time for participants to practice with these tools. Laptops are needed to complete the hands-on exercises. All the software needed will be provided by the instructor for installing on your laptop.

About the Instructor:
Ed Marshall is an independent technical writing consultant and sole proprietor of Marshall Documentation Consulting, with more than 22 years of experience. He specializes in APIs/SDKs (application programming interfaces/software development kits), Web services products, and other types of documentation aimed at developers. Throughout 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 and replacing text in files. Ed is a popular speaker at a variety of professional development conferences, locally and nationwide. His previous appearances include events sponsored by the Society for Technical Communication (STC), WritersUA, and DocTrain. Contact Ed at ed.marshall@verizon.net.

For travelers from out of town:
The hotel has a free shuttle to and from the Portland International Airport. The airport is a 15-minute drive from the hotel. Parking is free at the hotel, if you drive there.

Tabby Cat Communications negotiated a special rate with the Best Western Pony Soldier Inn for overnight guests enrolling in this course. It's $89/night, plus tax. To receive this special rate, call the Best Western Pony Soldier Inn directly at (503) 256-1504. Please note that this rate is not available if you book your room through the Best Western's website.

For more details and to register, see http://www.tabbycatco.com/2010-08-28.html.

We hope to see you in Portland!

Job Seeker Bootcamp

STC announces a FREE program for members who are currently seeking employment or contracts.

In this tough economic climate, STC would like to extend a helping hand to those conducting job searches. While members have free access to the Job Seeker Boot Camp, as well as many other benefits, STC has made this program available to nonmembers for the affordable rate of $65. So if you have friends or colleagues seeking employment, be sure to tell them about this special offer.

The STC Job Seeker Boot Camp includes four elements to help the effectiveness of your search:

• FREE access to the STC Career Center where NEW job postings specific to technical communicators are listed and shown to members EXCLUSIVELY FOR 14 DAYS before they are released to the public. STC recently partnered with the top recruiters in the tech comm field to post the best job openings on our Career Center.
  
• FREE access to a dozen-plus articles written by and for technical communicators about how to distinguish yourself, how to identify hidden job markets, what questions to expect during the interview, and how to increase your perceived value to your next employer. The work of technical communicators is an important contribution to a company’s bottom line. Learn what to emphasize when describing the value of your accomplishments.
  
• FREE access to audio podcasts by well-known STC recruiters. John Hedtke and Jack Molisani speak on topics such as: mistakes technical communicators make during job searches, résumé tips, creating buzz about yourself during your search, and how to ace the interview.
  
• FREE access to the latest STC Salary Survey to help you establish your value during negotiations. The survey also shows how technical writers have shifted from state to state or metropolitan areas, where salaries are holding firm, and where the largest increases in salaries have occurred. Learn what the average, median, and 90th percentile salary are for technical writers in your area.

HOW THE PROGRAM WORKS
The STC Job Seeker Boot Camp is presented as an additional FREE benefit for members.
http://www.stc.org/membership/job-seeker-boot-camp-intro.asp

Touchstone more>>