Software developers demand code samples as part of the documentation, but you may not know what to provide, especially if you don’t have software development background. Nevertheless, you can succeed! As it happens, effective code samples are a lot like effective documents, so you can apply your writing knowledge to delivering good code.
In this presentation, you’ll see how to apply good writing habits to delivering code samples, by learning about the following:
- Ineffective and effective code samples, and why they differ
- Writing guidelines for code samples
- Strategies for getting code samples from SMEs
- Developer community involvement
Even if you don’t know how to code, you can deliver effective code samples to your readers, and even improve how your SMEs write code. Effective code samples are clear, concise, easy to follow, and easy to read, so as a writer, you know more about writing good code samples than some engineers. Tune in to this webinar to learn how you can apply what you already know to delivering good code samples.
About Joe Malin
Joe Malin has a passion for both software engineering and technical writing, which he combines as a developer documentation specialist. Originally a software engineer for Hewlett-Packard, Joe went on to work as an internationalization engineer and product manager for software startups.
After joining Oracle Corporation to do internationalization for business tools, Joe switched to writing developer documentation for J2EE frameworks. He left Oracle to go to Google, where he was one of the first technical writers to work on Android developer documentation. He’s currently a Senior Technical Writer at EXO U USA, Inc., where he reports to the Director of Application Development and the Vice President of Engineering. Joe holds a B.Sc. in Chemistry from Haverford College and a certificate in Technical Communications from San Jose State University, and studied computer science at the University of Pennsylvania.
Date: Monday, May 18, 2015
Networking/social time: 6:00-7:00pm
Presentation time: 7:00-8:00pm+
Location: IHOP Restaurant, 4200 Great America Parkway, Santa Clara, CA 95054
Note: You don’t have to be an STC member to attend the meetings.