Portfolio – Technical Documentation

I write technical documentation for audiences ranging from engineers to end users.

 

API Documentation – Boardgames

I’ve worked with developers and product managers to document REST APIs. REST APIs consist of requests to and responses from a web server, essentially enabling two systems to talk to each other. I created a “boardgames” API to demonstrate what I typically include in my API documentation.

By the way, see Tom Johnson’s excellent Documenting APIs course for a high-level primer.

Design Specifications – Add Performance Support to MSP Web App

Written with an Agile sensibility to give developers the “just-in-time” (JIT) information they needed to add help functionality to the a web app.

Installation Guide – Install Flip PDF Professional

Written for the desktop support team to help them download and install the Flip PDF Pro software. As with all my installation guides, I designed this to be short, simple, and loaded with screen shots to ensure clarity.

Job Aid – eBuy

A tri-fold, graphics-based job aid that gave field associates a quick overview of the web app’s primary functions.

Online Help / Performance Support – Learning Management System (LMS) User Help

Written and developed to fully integrate into a Learning Management System (LMS) workflow so that users had the help they need at the moment they needed it. Tools: Ontuitive Learning Guide Manager, MS PowerPoint, SnagIt.

Process Flow Chart – RFID Workflow

Obtained workflow by facilitating interviews with subject matter experts.

Release Notes – Core Product 1.5

My product release notes briefly explain new features and any bug fixes. They provide links to related documentation and guidance on where to go for help with the new features.

Style Guide – Writing for the Web

Written for a team of technical writers to ensure the team’s web content had a consistent style, look, and feel.

Task Analysis – Run a Full Cycle Count

Obtained this task-based information by facilitating an interview with subject matter experts. This information ultimately went into an online performance support system, where each topic page had three tabs for Quick Steps, Detail Steps, and Supporting Knowledge.

User Guide – ILP File Manager User Guide

Provides task-based instructions on how to use a content management system that fed an in-house built Learning Management System.