Technical Writing Samples
Len Humbird, technical writer
I produced each of these during my employment with the clients and employers stated below. In each case, I have either created them from scratch or produced substantial content and presentation methods. Each sample represents a type of document types I can create for your business.
| Industry | Title/Link | Sample Type | Audience | Notes |
| Medical Information Services | Linking and Single Sign-On Programmer Reference (2022) |
Flare-sourced PDF | Medical IT | This software technical reference explains how to build interfaces for electronic medical record (EMR) application, electronic health record (EHR) application, or practice management system (PMS) into the company's product suite. |
| Medical Information Services | Security Migration for Consultants: Migrating API Endpoints (2022) |
Flare-sourced PDF | Medical IT | This procedure instructs software integration developers in migrating their security API to the latest standard. |
| IT/Telecommunications | Example help template (2021) |
PMD-sourced HTML | Military deployed IT personnel | This is a simple example of a help template for the company's communications management software. (A live version of this help would be integrated into the software product during the software build process.) It demonstrates page style, text styles, navigation, and linking to external help files. |
| Hospital Revenue and Medical Records | Medical billing software user guide (2019) |
Word-sourced PDF | Company clients and prospects | The user guide provides a technical description and illustrated step-by-step guide for the company's clinical coding and billing software system used for a patient stay at a hospital. |
| Industrial Energy Efficiency Management | Software Development Methodology (2018) |
Word-sourced PDF | Company clients and prospects | This document explains the methodology used by a software development team. It shows how the team manages and tracks iterative and incremental software enhancements using an Agile-based software development life-cycle (SDLC) process. |
| Sports/Athletic Apparel Manufacturer | Access Review Placemat (2017) |
PowerPoint-sourced PDF | Internal Managers | This is a two-page infographic for use in the company's Identity and Access Management (IAM) manager training classes. It is in-use worldwide. |
| Computer Manufacturer | Firmware Engine SDK User Guide (2016) |
Word-sourced PDF | Intel architecture firmware developers | This is a 450-page "cookbook" for developing UEFI firmware for Intel-based products. I took ownership of this document from a firmware developer. I crafted the presentation and made extensive technical corrections and additions, and making the content complete and easier to use. |
| Credit Card Processing Services | Payment Processing Gateway Use Cases (2015) |
Business-to-Business API Messages Use Cases | Company clients and business partners | This document helps client businesses understand and integrate their API messages into their checkout workflow. |
| Insurance Products and Services | Disaster Recovery Factory PrismPro DR Document (2012) |
Word-based Disaster Recovery Procedures for internal IT department | Internal IT staff | Part of a set of procedures used to coordinate many technical departments in re-establishing normal operations after a data center has been disabled due to a regional disaster. |
| Computer Manufacturer | Enterprise Product Lifecycle Management (PLM) procedures
(2012) |
Online Help for a developer framework | Internal database application developers | Help system was installed in the development environment. It guides new developers in setting up and configuring their workstation for developing the company's enterprise-level db applications that utilize an application framework and portal access. About 100 help topics. |
| Office Products Manufacturer | Office Printer Help System (2008) |
Device-embedded help for a sophisticated multifunction printer | End-users, system administrators | Help system is embedded in the product, accessed via web. Localized into 12 languages. Produced using a content management system. More than 300 topics. |
| Insurance Producs and Services | BaRT Invoice Generation and Release (2008) |
Word-based reference and user guide | Internal IT staff and business analysts | This sample shows some of the rich structure and design that went into a typical internal technical document. Efficient structure and design aids readability. |
| Computer Manufacturer | Help system for network adapters (2005) |
Online Help for LAN adapters and drivers | End-users, system administrators | Help system is installed in the end-user's computer along with driver software. This help system supported the entire family of LAN adapters. It contains nearly 200 topics. I authored nearly all of the content. |
| Retail Video Sales | Store-to-Oracle Data Flow Architecture (1999) |
Word-based corporate data flow architectural document | Internal IT staff | Part of an intradepartmental coordination effort to understand how weekly and quarterly business reports are automatically produced. To produce this document, I interviewed dozens of programmers and database analysts throughout the IT department, and pieced together this document. This was the first time the entire department could see and understand how their data was utilized. It details what data is generated, what software process moves or manipulates that data, and the timing and other inter-dependencies that keeps everything running. Contains several Visio diagrams, including data communications infrastructure, data flow, functional flow, process flow, and others. |
| Computer Manufacturer | Tracker (1998) |
Word-based user guide | Internal IT staff and business analysts | This is an example of content, organization and layout in a Word-based user guide. |
| Computer Manufacturer | ToolBox Reference ToolBox General Info ToolBox Desktop Intro (1998) |
Word-based user guides | Internal IT staff and business analysts | ToolBox is a set of software tools for a supply chain management system. Includes Word-based chapter samples. The help file and Acrobat PDF files provided documentation for users. These are examples of single-sourcing used to generate help, printed, and PDF outputs. |
| Computer Manufacturer | Technical Publications Style Guide (1998) |
Word-based style guide and reference | Internal technical writers | This is one of many style guides I produced for clients who had no standard reference for producing technical publications. |