This page contains samples of work I've done at various times in my technical writing career.

Note: Some of these pages have been converted into HTML from their original source formats, or archived from their original web locations. Layout and format may not be ideal, and links may lead to missing pages.

PDF Icon Indicates an Adobe PDF document.

locked Indicates a protected file. Contact me for the username/password.

Programmer's Guide: Data Management Framework (2010) locked

Technical overview documentation for a complex programming framework written in C# and .NET. This programmer's guide was developed both in a structured HTML Help format and as a traditional linear book (at different times).

SDK Documentation: Yahoo! Enterprise Web Services (2006)

- Introduction to SOAP

- User Management Service API

Enterprise Web Services is a SOAP API for the Yahoo! advertising platform. I was the lead for this project in its first release; I designed the structure of the documentation set, created the web-based templates, and wrote a large portion of the text. The documentation set for this project consisted of two parts:

The API documentation was automatically generated from the Java source using a custom Java doclet. The doclet was developed in conjunction with the engineering team so that the output was useful for SOAP programmers and fit the design of the web templates. To write the API documentation the writers and myself worked directly in the Java source code with a developer build environment, following all the same processes for compilation, testing and check-in that the developers used.

Tutorial: AJAX, Yahoo! Developer Network (2006)

At the Yahoo! Developer Network we provided publicly available documentation for Yahoo! platform APIs, as well as short tutorials on various web development topics. I was the managing editor and lead writer for this site.

The voice and tone of the writing on the Yahoo! Developer Network was very informal and conversational, closer to a blogger or person-to-person support voice than that of traditionally written documentation.

API Reference: Yahoo! TripSearch (2006)

Yahoo! TripSearch was a REST-like API for a travel service. In addition to designing and writing the documentation, I helped with the design of the API itself, ensuring that the parameters and results were user-friendly and consistent with other available Yahoo! APIs.

Command Reference (2005) locked

A reference guide to a minimal assembly-like programming language for a mobile device.

This document was written on an internal company wiki, and was live the entire time it was in development. Comments and questions were added inline and incorporated as part of the writing process.

Tutorials: Sun Java Studio Creator (2004)

- Getting Started With Sun Java Studio Creator

- Developing a Web Application

I wrote a number of introductory tutorials for this project, a visual Java IDE similar to Microsoft's Visual Studio.

To ensure consistency for these documents across several writers and engineers we tightly defined the structure, length, and format of each tutorial. "Conceptual" tutorials such as Getting Started describe topics without examples or steps; "Walkthrough" tutorials such as Developing a Web Application have procedural steps and a simple example with no concepts. All the tutorials include standard introductory, Summary, and See Also sections.

These documents were written in Star Office (OpenOffice.Org) and converted to HTML and PDF by Sun's Web production team for integration with the company CMS.

Technical White Paper (2000) PDF Icon locked

A technical white paper for a secure smart card product.

Book Chapter: Regular Expressions in Perl (1998)

A chapter I wrote for the book Teach Yourself Perl in 21 Days. Regular Expressions enable you to describe a text pattern and then match that pattern inside your data. They are one of the more complex features of Perl and many writers find them very difficult to describe. Many readers have told me this chapter (and the one that followed it in the book, which continued the discussion) are the best beginning description of regular expressions they have ever seen.

This chapter follows the "Teach Yourself" tutorial format, which is intended to be read from start to finish, and is written in a very conversational style. The audience is beginning programmers. Warning: a long chapter.

Column: "Consider the Source" from (1998) (local copy)

This is not really technical writing, but reflects some of the writing I have done on technical topics with a humorous tone.

When the Netscape source code was released under the Mozilla project in 1998 I was asked by Salon to read the code and do a "review" of it. This piece was the result.