I’ve been creating technical documentation since 1984. I started out working on print documentation but have transitioned to online documentation and training. This page provides samples of documentation.
Samples available here
NOTE: I have permission to share all samples for demonstration and evaluation.
ESS-Overview — Print/PDF sample of a system overview of an online storage system. This is from around 2003. This iDrive company closed down shortly after this was written. It has no connection to the current iDrive company.
Online Help for ArticleExpress — This Help supports a SaaS product used for editing STEM articles, proofing them, and preparing them for print and online delivery. Each instance of Help is tailored to the individual client and journal.
Advice for New Technical Writers — Some advice for the new technical writer, published on LinkedIn.
Introduction to ARTEMIS — Recorded introduction to training. ARTEMIS is an asset management service for STEM publishing. Employees view this before taking classroom training.
Using the Publisher Center — Quick Reference PDF for clients using The Publishing Center, a web application used to manage and retrieve published articles.
When You’re Stuck.pdf — Job aid for ARTEMIS users needing assistance.
Training videos (Videos open in a new window)
Adding a Citation to a Table Footnote – Adding a citation to an item in a table row is easy. But you need the Element Editor to add a citation to a table footnote.
Fixing a Broken Figure – Is that missing/broken figure really missing? Do you need to have TNQ process another graphic? It might just be misnamed. Use the Element Editor to fix it.
Editing References with the Element Editor – If punctuation is missing, use the Element Editor to add it back in.