These are a few samples of the documentation I’ve created. Most examples shown here were available to the greater community as both HTML and PDF.
Checkr
Led all product documentation efforts for the company, including user guides for the Checkr dashboard, programming and API guides for the Checkr APIs, content for candidate emails, and UX and contextual help strings for the dashboard.
docs.checkr.com presents our developer materials, which are managed in GitHub, and powered by Redoc.ly.
help.checkr.com presents customer and candidate FAQs. It also hosts product information, including Features guides, a Getting Started guide, Screening types, user guides for both legacy and Account Hierarchy enabled dashboards, and Release Notes.
CoreOS
Restructured and updated all supporting documentation for CoreOS’ major projects, including Container Linux, etcd, flannel, Quay and Quay Enterprise, and Tectonic.
I also wrote myself a Git for Beginners tutorial.
Note: CoreOS was acquired by Red Hat in January, 2018. RedHat was then acquired by IBM in October, 2018.
Livefyre
Led the documentation development process for the internet’s leading real-time conversation and curation platform. Designed a new documentation site for both developer and dashboard user guides, and managed build out in WordPress, allowing broader employee access, and removing the need for engineering support. Began the process by which all APIs were moved to Swagger.
answers.livefyre.com: Included Developer Guides, Programming Guides, and a User Guide for the Studio interface. My work, completed close to the April 2016 version, is available through the Internet Archive. The Strategies pages belonged to the marketing group.
Livefyre APIs: Listed and described all publicly available Livefyre APIs. Work was well underway to port from Django to Swagger upon my departure.
Playa Pete’s Plaza
Harbor Master and theme camp organizer for Playa Pete’s Plaza, home port of the Monaco and Kaleidoscope. Project manager for the camp and updates to our toys. Schedule, define, and create all relevant emails and training materials. I’ve included a few of the more significant pieces here.
The Rules
Camp Sponsor Program
Burning Man is not a festival
MOOP and the cleansing thereof
The Bar: Our favorite watering hole
Boobies and Boundaries
Vindicia
Created all internal and end-user documentation, from internal merchant configuration settings and specs, to payment processor interaction outlines, to end user and developer guides, API SDKs, and best practices docs. Designed an online documentation knowledge base to serve as reference for internal users.
CashBox 4.0.5 User Guide
CashBox 5.0 API Guide
CashBox 5.0 Programming Guide
TVoT Gallery
Generated all requisite documentation for the TVoT Gallery at the Yerba Buena Center for the Arts in San Francisco, from artist solicitation and vendor information spreadsheets, to gallery floor plans, to the Gallery Catalog.
2012 Gallery Catalog
2011 Gallery Catalog
ClarusIPC
Ported existing documentation from Mac OS to PC software, rewrote and redesigned the entire doc set, and updated documentation through the software revisions.
User Guide: A comprehensive User Guide for the core ClarusIPC product.
Dashboard Guide: Guide to the near real-time performance management tool, which allows users to monitor server health, gateway capacity, media resources, and device registration for their IP Communications system.
Help Desk Guide: Guide to the real-time device troubleshooting application, which allows users to remotely access, troubleshoot, and verify fixes to IP Telephony devices, without involving the end-user.
Voice Monitor Guide: Guide to the Configuration Management tool, which provides an extensive Unified Communications systems change tracking, monitoring, alerting, and reporting interface.
Network Connectivity Diagram: Schematic to set up CUCM Network connections for the ClarusIPC product.
Installation Guide: Standard installation instructions, plus server group setup diagrams.
Training Guide: Workbook for use in parallel with ClarusIPC Services training sessions.
Finaplex
Analyzed existing operations, then defined the process by which the company could transition its customized services to a shrink-wrapped product (Finaplex On Demand). Developed materials lists, project plans, developer instruction manuals, and other required documentation.
FOnD New Customer Setup Workflow: Diagram of new in-house workflow for creating and maintaining a customer relationship.
FOnD New Customer Setup Wiki: Text based storyline / fleshed wiki description of the workflow, with links to relevant support docs.
FOnD Demo Script: A quick and dirty, one afternoon’s work, demo script for in-house use only. This was written for the VP of Marketing to use for a product demo the next morning. As the product changed daily, the script needed to be specific to the previous day’s build.
House of Louie
Designed and implemented retail appliance company’s first inventory control system. Trained and oversaw new working systems in all departments, including Sales, Shipping, Billing, Purchasing, and Management. Trained all departments in new software systems
House of Louie Procedural Notes: Generalized operating procedure document to move the company from their previous order tracking software, to the new inventory control procedures and tracking software.
TrueReq / Green Array
Served as Beta Tester / Professional feedback for Project Management software, and designed and created in-line documentation set.
All docs were embedded within the product as HTML.
Desktop.com
Designed and wrote a complete documentation set for a hosted personal web-based tool kit and file storage system. All Desktop.com documentation was embedded within the product. The only PDF available was the developers’ guide.
Intervista
Designed and wrote complete documentation set for a VRML development company: a real-time, web-based modeling engine browser plug-in. Most documentation was in-line, created using raw html and RoboHelp. The developer APIs were available as PDF.
After Intervista was acquired by Platinum Technology, the original WorldView product was altered and embedded in the Platinum product as WorldChart. All documentation was rewritten and reformatted to the Platinum standard.
WorldChart User Guide
Platinum WorldView for Developers User Guide