John Reynolds, Technical Documentation: Writing Samples

Writing Samples

I offer these writing samples to demonstrate my style for organizing and explaining the complexities of our technical world.

The selections below have a common theme: they demonstrate completely or primarily my writing. (Exceptions are noted.)

Rest assured I can revise existing documents and professionally adhere to corporate templates, published precedents, and style guides. If, however, you want to know my writing style, you will find it in these samples:

NOTE: These files do not contain proprietary information or trade secrets. Nonetheless, they are available only by request from prospective employers or clients. To request, please send email.

File name	File size	Contents
wrsamples_reynolds_j2.zip	358 K	Zip file includes Adobe Acrobat (.pdf) files, as follows: ez_backup_script_instruc.pdf - A FrameMaker document I produced, December 2001, while working at BMC Software. The document explains how to install, configure, and run the EZ-Backup Script, which automates the process of backing up important document files to a file server. I wrote both the script and the instructions. s100dev_excerpt.pdf - An excerpt of a FrameMaker document that I produced while working at Daniel Industries, April 1999. Entitled Spectra 100 Developers Guide, the document is a reference for developers who are producing data collection systems that will communicate, via Modbus protocol, with this model of gas flow computer. As a writing sample, this excerpt contains an amalgamation of my own writing, plus revised source material from the Daniel developers and Modbus specifications from Gould, Inc.
wrsamples_reynolds_j.zip	337 K	Zip file includes several Windows Help files, as follows: Acodenew.hlp - produced in January 1997 to learn how to build Windows Help files with Paul Arnote's shareware program, MiniHelp Plus. A page out of history, this document was a reference guide to the new 281 area code for Houston phone numbers. Csforum.hlp - produced in September 1997 to learn how to build Windows Help files with Blue Sky Software's RoboHelp. Another page out of history, this document was a quick reference guide offered to users of the CompuServe Forums interface, before CompuServe became part of America Online to exist as another web portal. Jfamly_it.chm - produced in February 2000 while I worked at PG&E Energy Trading. This document served two purposes: (a) it provided a reference that Human Resources and IT department managers could use for identifying job descriptions and (b) it helped me learn how to build compiled HTML Windows Help files with Blue Sky Software's RoboHTML. I wrote the introductory explanations, then incorporated many existing MS-Word documents as content for the detailed job descriptions. S100dat.hlp - produced in June 1998 while I worked at Daniel Industries. This document was produced from a combination of ASCII text output from a Microsoft Access application that I made, and then processed with MiniHelp Plus. The document is an online reference for the Spectra™ 100 Flow Computer. I wrote all of the material, based on input from the development engineers. S100usr.hlp - produced in March 1999 while I worked at Daniel Industries. This document was produced with RoboHelp. This document is an online user's guide for the Windows-based software controlling the Spectra™ 100 Flow Computer. I wrote all of the material, based on input from the software developer and customer support representatives. There are some unfinished parts because this was a work-in-progress when I left Daniel to work for PG&E ET.