Lynn Gold: Writing Samples

This page contains several samples of my technical documentation. Unless otherwise indicated, I did all the design and writing of these documents.

API Documentation

The following files are examples of documentation written for programmers.

• Lenovo Network Python Programming Guide For Lenovo Cloud Network Operating System 10.3 (Acrobat file) - Tools used: FrameMaker, Acrobat.
  This documented an all-new API for an all-new operating system.
  Note: The fixed width font somehow got corrupted when I transferred this file. I am aware of the problem.
• Lenovo Network REST API Programming Guide For Lenovo Cloud Network Operating System 10.3 (Acrobat file) - Tools used: FrameMaker, Acrobat.
  This was the first REST API document done by our group at Lenovo. I created our standard of how to document REST APIs and JSON code.
• Developer's Handbook for Search Server and AgentXpert (Acrobat file) - Tools used: FrameMaker, Acrobat.
  This documents a CORBA-based C++ API for Netscape's PublishingXpert suite. I wrote this in less than a month following Netscape's style guide with modifications to match the writing style of the other API writer working on PublishingXpert.
• BroadVision InfoExchange Portal Developer's Guide (Acrobat file) - Tools used: FrameMaker, Acrobat.
  I wrote 90% of this and served as the lead writer for this product. This document follows BroadVision's internal style guide.
• PayPal Refund API User's Guide (.DOC format) - Tools used: Microsoft Word
  I created this from scratch in less than two weeks. It documents PayPal's SOAP-based API and how to interface with it using C++, C#, and Java.
• ZipLip Development Kit (Acrobat file) - Tools used: FrameMaker, Acrobat.
  This describes how to interface with ZipLip's Java API instead of using Web services directly. It does not document the API itself, but explains how to use it.

Administrator Documentation

The target audiences for these are product, system, and database administrators.

• MarkLogic Server Ops Director Guide (Acrobat file) - Tools used: FrameMaker, Acrobat, SnagIt, Photoshop.
  This product runs on top of MarkLogic Server to enable customers to administer MarkLogic Server more easily, especially over a cloud-based configuration. I was responsible for this guide. The parts I wrote include Chapter 2, "Installing and Configuring Ops Director," and in Chapter 7, section 7.3, "Configuring Email Notifications." This contains directions in XQuery and REST (via curl) designed for someone who might not be familiar with either.
• Lenovo CNOS Quick Start Guide (Acrobat file) - Tools used: FrameMaker, Acrobat.
  This is a two-page document that enables customers to quickly get a switch up and running. I wrote this from scratch and designed the format in conjunction with the Product Manager.
• InfoExchange Portal Administrator's Guide (Acrobat file) - Tools used: FrameMaker, PaintShop Pro, Acrobat.
  I wrote this from scratch and helped design the Welcome screen for the Admin tool. This document was written following BroadVision's internal style guide.
• ZipLip Administration Guide (Acrobat file) - Tools used: FrameMaker, SnagIt, Photoshop, Acrobat, Visio.
  This describes how to administer ZipLip's compliance and archival platform.

Networking and Network Security Documentation

The target audiences for these are network administrators.

• IPsec with IPv6 chapter of the Rackswitch G8052 Application Guide for Lenovo Network Operating System 8.3 (Acrobat file) - Tools used: FrameMaker, Acrobat.
  Rather than posting the entire book, I instead extracted the one chapter I wrote from scratch. I logged onto Lenovo's switches to validate the commands.
• IBM iFlow Director User's Guide (Acrobat file) - Tools used: FrameMaker, Illustrator, Photoshop, Acrobat, Visio.
  I wrote roughly 70% of this book, which describes how to configure load-balancing switch firmware.

End-User Documentation

These are written for end-users of varying levels of technical sophistication.

• NETGEAR RangeMax Dual Band Wireless-N USB Adapter WNDA3100v2 Installation Guide (Acrobat file) - Tools used: FrameMaker, Illustrator, Acrobat.
  A two-sided, trifold one-sheet installation guide enclosed with the wireless adapter.
Probix Trustee for Meetings User's Guide (Acrobat file) - Tools used: FrameMaker, SnagIt, PhotoShop.
The user's guide for the HTML-based Probix Trustee for Meetings.
• Probix Trustee for Outlook User's Guide (Acrobat file) - Tools used: FrameMaker, SnagIt, PhotoShop.
  The user's guide for the Probix Trustee for Outlook add-in to MS Outlook; includes installation instructions.
• Probix Trustee User's Guide (Acrobat file) - Tools used: FrameMaker, SnagIt, PhotoShop.
  The user's guide for the HTML-based Probix Trustee product.

Online Help

These are all enterprise online help systems I've designed and written.

• Probix Trustee for Meetings Online Help (HTML) - Tools used: DreamWeaver, Fireworks.
  I designed this to have the same look and feel as the HTML-based Probix Trustee for Meetings product.
• Probix Trustee for Outlook Online Help (Compiled MS HTML Help) - Tools used: RoboHelp, HTML Help Workshop, Emacs.
  The online help for the Probix Trustee for Outlook add-in to MS Outlook.
• Probix Trustee for Outlook Online Help -- Japanese (Compiled MS HTML Help) - Tools used: RoboHelp, HTML Help Workshop.
  The online help for the Japanese version of the Probix Trustee for Outlook add-in to MS Outlook. I took text translated into Japanese and retrofit it into the MS HTML Help files.
• Probix Trustee Administration Tool Online Help - Tools used: RoboHelp, HTML Help Workshop, Emacs.
  I designed this to have the same look and feel as the HTML-based Probix Trustee Administration Tool. It has the following context-sensitive entry points based upon where you are in the Probix Trustee Administration Tool:
  • Customer Administration
  • Manager Administration
  • Probix Server Administration
  • Rights Administration
• Probix Trustee Policy Manager Online Help - Tools used: DreamWeaver, Fireworks.
  I designed this to have the same look and feel as the HTML-based Probix Trustee Policy Manager. It has the following context-sensitive entry points based upon where you are in the Probix Trustee Policy Manager:
  • User Management
  • Content Management
  • Group Management
  • Member Management
  • Policy Management

Configuration, Troubleshooting, and Best Practices Documentation

These contain information on how to set up and debug products.

• "Request Monitoring" chapter from the MarkLogic Query Performance and Tuning Guide (Acrobat file) - Tools used: FrameMaker, Acrobat.
  The initial text was based on a feature specification, but I tested everything to make sure it worked. The audience is an administrator who is familiar with MarkLogic Server and JSON. I wrote this chapter from scratch.
• Probix Trustee Troubleshooting Guide (Acrobat file) - Tools used: FrameMaker, Acrobat.
  This was used by Probix sales and support and by the support staff of Probix's resellers to cut down on the calls the resellers needed to make to Probix.
• Configuring LDAP Fields Within ZipLip (Acrobat file) - Tools used: FrameMaker, SnagIt, Acrobat.
  This technical note describes how to override ZipLip's product suite default settings to get it to read a configuration file for LDAP Discovery settings. The target audience was OEM resellers.

Miscellaneous

I did these for nonprofits in which I've been involved.

• ConJosé Local Resources Guide (HTML) (PDF) - Tools used: FrameMaker, Acrobat, Photoshop, Emacs.
  I created this for the 2002 World Science Fiction Convention which was held in San Jose, CA.
• Consonance 2003 web site - Tools used: Emacs, Photoshop.
  I served as webmistress for this non-profit from 1997 till March, 2003. I designed and created the logo, and all content is by me except where otherwise indicated.