+ resume

Documentation

Import Guide

Purpose

The Import Guide is a collection of procedures, guidelines, and tips that I wrote for the Washington Undergraduate Admissions Office to document critical tasks that must be completed on a weekly or semi-annual basis. This guide can be used by new employees to learn how to complete critical tasks, or it can be used by existing employees as a reference. Tasks include importing student data, modifying data collection forms, and changing code to back-end web interfaces.

Features

The Import Guide features screenshots, code examples, and styles for all of the documentation elements. The pictures and code examples throughout the documentation help to make understanding the material easier for new employees, provides additional information about context for the given application, and increases situation awareness. The documentation styles used throughout the document allows for easy updates and additions.

Flickr Help Procedure

Purpose

To create an online help system for the online photo sharing web site, Flickr. Flickr does not have a help system of its own on their website; this procedure is one of many that I wrote for a group project to document its features. The deliverables include an online help system and a printed user's guide.

Features

I designed the MS Word template used in this example, as well as throughout the project, to mimic the Flickr Theme. In addition to creating the style template, I built a toolbar within Word to provide easy access to all of the documentation styles in logical menus.

The procedure is written for beginner to intermediate Flickr users and follows the Microsoft Manual of Style for documentation consistency. One challenge presented in this example is that Flickr uses unconventional navigation throughout its interface, which needs to be explained to users with limited experience. Flickr also provides the user with multiple methods for performing the same task. I overcame this challenge by integrating multiple list bullet items within the numbered list to represent each method for performing the task.