Technical Documentation
User manuals & administration guides ⌖ Installation & upgrade guides ⌖ Release notes & patch notes ⌖ Developer documentation & programming guides ⌖ API & schema references ⌖ Planning & deployment guides ⌖ Troubleshooting guides & FAQs
This page provides links to some samples of my technical documentation work.
These documentation samples are also available in a single ZIP download (15.9MB).
Please take a look at my other samples
These samples are not a comprehensive catalog of my work. For additional samples, or for additional information about the samples provided here, please contact me.
Samples
Active>360 Installation Guide
Chapters from the Active>360 Installation Guide
- I wrote and illustrated the Ab Initio Active>360 Installation Guide.
- The first sample here, “Performing an Active>360 installation,” describes procedures for preparing an Active>360 installation environment, running the Active>360 installation scripts, and verifying the installation.
- The second sample, “Active>360 installation configuration parameter reference,” provides an overview of Active>360 installation configuration parameters, followed by reference information for each parameter.
- Note that the parameter reference sample here is just the first 16 pages of the chapter — the complete chapter is over 130 pages.
>> View Performing an Active>360 installation (829K PDF)
>> View Active>360 installation configuration parameter reference (561K PDF)
2024
Active>360 Release Notes and Patch Notes
Release Notes and Patch Notes documents for the Active>360 product
- I wrote and illustrated these Release Notes and Patch Notes for versions 4.2.2 and 4.2.1.4 of the Ab Initio Active>360 product.
>> View Active>360 Release Notes (1MB PDF)
>> View Active>360 Patch Notes (703K PDF)
2023
Overview of Active>360 APIs
“Overview of Active>360 APIs” chapter from the Active>360 API Reference Guide
- I wrote and illustrated the Ab Initio Active>360 API Reference Guide.
- This sample chapter provides conceptual and usage overviews of the Active>360 APIs.
>> View Overview of Active>360 APIs (504K PDF)
2022
Implementing CIP event types
“Implementing CIP event types” chapter from the Customer Interaction Platform API Guide
- I wrote and illustrated the Ab Initio Customer Interaction Platform CIP Interfaces/API Guide.
- This chapter provides a conceptual overview, detailed reference information, and procedures for defining CIP events.
>> View Implementing CIP event types (1MB PDF)
2021
RMI-IIOP Load Balancing and Failover
“RMI-IIOP Load Balancing and Failover” chapter from GlassFish Server High Availability Administration Guide
- I wrote and illustrated the Oracle GlassFish Server 3.1 High Availability Administration Guide.
- This chapter describes using high-availability features for remote EJB references and JNDI objects over RMI-IIOP in GlassFish Server.
2011
GlassFish Web Space Server Installation Guide
Sun GlassFish Web Space Server 10.0 Installation Guide
- I wrote and illustrated this guide for the GlassFish Web Space server product that was co-branded by Sun Microsystems and Oracle Corporation.
>> View Sun GlassFish Web Space Server 10.0 Installation Guide (1.4MB PDF)
2010
GlassFish Web Space Server OpenSSO Add-On Guide
Sun GlassFish Web Space Server 10.0 OpenSSO Add-On Guide
- I wrote and illustrated this guide for the GlassFish Web Space Server product from Sun Microsystems.
>> View Sun GlassFish Web Space Server 10.0 OpenSSO Add-On Guide (1.6MB PDF)
2009
PeerDirect SDK Installation Guide
PeerDirect Distributed Enterprise SDK Installation Guide
- I wrote and illustrated this guide for the Database Replication Engine product from PeerDirect.
- The PeerDirect Distributed Enterprise SDK was a development environment for building and testing PeerDirect Replication Networks.
>> View PeerDirect Distributed Enterprise SDK Installation Guide (1.4MB PDF)
2003
Visual Orchestrate reference cards and User’s Guide
API Reference/API Reference Cards, User’s Guide
- I designed, wrote, and illustrated a pair of API reference documents and a developer-level User’s Guide for the Visual Orchestrate product from Torrent Systems. (Torrent Systems was subsequenlty acquired by Ascential Software and then by IBM.)
- Visual Orchestrate was an environment for developing parallel-processing applications using standard sequential-programming models.
- The first two pages of each API reference document are meant to be printed double-sided to create foldable quick-reference cards.
- When viewed online in PDF format, each quick-reference entry in the the API documents is linked to its corresponding full reference section later in the given document.
>> View Visual Orchestrate User’s Guide (2.5MB PDF)
>> View API Reference by Class (1.3MB PDF)
>> View API Reference by Header (1.4MB PDF)
2000–2001
NuSphere Advantage Installation Guide
MySQL installation guide
- I wrote and illustrated this installation guide for the Advantage MySQL distribution from NuSphere Corporation.
2001
UNIX for Windows Users
“UNIX for Windows Users” chapter from Wabi 2: Opening Windows
- This is a sample chapter from my book, Wabi 2: Opening Windows.
- I designed, wrote, and illustrated the book, which was cited as a “Best Book of 1996” by UNIX Review magazine.
- A precursor to the open-source Wine project, Wabi was a Windows application binary interpreter, developed by Sun Microsystems, that enabled users to run Windows applications in UNIX-based X Window environments.
- This sample chapter provides Windows users with a basic introduction to UNIX concepts.
>> View UNIX for Windows Users (740K PDF)
1996
Xerox/Kurzweil PC/KPR User Manual
Chapters from the Xerox/Kurzweil PC/KPR User Manual
- I designed and wrote the Xerox/Kurzweil PC/KPR User Manual for the Personal Computer/Kurzweil Personal Reader product set.
- The Personal Computer/Kurzweil Personal Reader was a set of products that enabled visually impaired users to read printed books, magazines, and documents.
- The product set was a combination of hardware components, software drivers, screen reader modules, and an end-user application.
- I optimized the design the printed documentation for optical scanning and processing by the screen reader modules.
- I developed the conceptual information and procedures through extensive hands-on testing (even while blindfolded), and through many usability tests with visually impaired users.
- I worked with Underwriters Laboratories (UL) to obtain UL approval for all documented tasks and guidelines.
- The samples included here are three chapters from the User Manual.
>> View Introduction to the PC/KPR System (773K PDF)
>> View The PC/KPR Co-Processor Board (2.2MB PDF)
>> View The Model Twenty-Five Scanner (3MB PDF)
1989