Samples

Since I began my career as a technical writer in 1994, I have created numerous types of documentation for a variety of software products. My portfolio is given below, categorized by type of document.

User's guides |  Release notes |  Online help |  White papers |  Web sites |  Manual pages (UNIX) |  Training |  In-house documents

User's guides

    Global Workload Manager User's Guide (2007 - 2008: two editions)
    Created a task-based manual (by merging a Getting Started paper and an Administrator's Guide) to assist system administrators in configuring the Global Workload Manager, a product that dynamically allocates resources across one or more servers to ensure prioritized policies are met.

    HP-UX Workload Manager User's Guide (1999 - 2005: seven editions)
    Created a task-based manual to assist system administrators in configuring the HP-UX Workload Manager, a product that dynamically allocates resources on a single server to ensure prioritized service-level objectives are met.

    HP-UX Workload Manager Toolkits User's Guide (2002 - 2005: eight editions)
    Created manual based on WLM Oracle® Database Toolkit User's Guide to include new toolkit products such the SAS® and Duration Management toolkits.

    HP-UX Workload Manager Oracle Database Toolkit User's Guide (2001)
    Created manual to help customers better manage systems running Oracle.

    HP Process Resource Manager User's Guide (1998 - 2008: eleven editions)
    STC Award of Merit, 2000

    Updated manual, ensuring consistent terminology, organizing the material in a more logical and task-based manner, adding a "Getting Started" section, explaining functionality in more detail, and generally making the manual more user-friendly. The associated software partitions system resources to ensure applications receive certain amounts of CPU, real memory, and disk bandwidth.

    HP Network Connection Policy Manager (1998)
    Updated manual, documenting the new Windows NT functionality for this load-balancing software.

    Exemplar Programming Guide for HP-UX Systems
    Updated manual to explain efficient programming techniques on the HP-UX operating system. Formerly, the manual was specific to the SPP-UX operating system. Added information for the new Fortran 90 and aC++ compilers.

    Exemplar Programming Guide: S-Class and X-Class Servers (1997)
    After being purchased by Hewlett-Packard (HP), developers at my division added the functionality of the Convex compilers to that of the HP Fortran 77 and C compilers. Consequently, I updated this manual to explain the new HP-based compilers that combined features of both compilers. This was a major revision of the manual that required reviewing, assembling, and editing information from many HP manuals to give a more complete picture of the functionality of the standard HP compilers, as well as making sure all the features added by developers at my site were documented.

    Exemplar C and Fortran 77 Programmer's Guide for HP-UX Systems
    Changed the focus of book from the SPP-UX operating system to the HP-UX operating system.

    Exemplar C and Fortran 77 Programmer's Guide: S-Class and X-Class Servers (1997)
    STC Award of Excellence, 1998

    Created manual to explain the Convex extensions (command-line options, directives, and pragmas) available in the HP-based compilers. Created a chapter dedicated to assisting customers who were migrating from the Convex compilers to the new compilers. Information on the assembler, the linker, the debugger, the profiler, and various system utilities was also provided.

    Using Large Files on SPP-UX (1996)
    Updated manual to explain large files on the SPP-UX operating system, working with large files using UNIX commands, and working with large files in C or Fortran 77 programs.

    Checkpoint/Restart User's Guide (1996)
    Updated manual from the ConvexOS operating system to the SPP-UX operating system, making numerous changes to improve readability as well as consistency in terminology and use of fonts.

    Advanced Optimization Package User's Guide (1995)
    Updated the manual to reflect the new compiler interface to the Advanced Optimization Package software.

Release notes

Online help

    gWLM (2004 - 2007)
    Created an HTML-based help system for the gWLM graphical user interface.

    wlmgui (2004 - 2005)
    Created JavaHelp system for the WLM graphical user interface.

    xprm (1998 - 2005)
    Created JavaHelp system for the PRM graphical user interface.

    HP aC++ Online Programmer's Guide (1998)
    Worked with another Hewlett-Packard writer to develop aC++ (ANSI C++) compiler documentation. I was responsible for documenting the extensions added to the compiler at my site, ensuring that these changes had the same form and style as the guide to which they were being added.

White papers

    Migrating from WLM to gWLM (2006 - 2007)
    Developed paper to help users determine the WLM functionality available in the newer gWLM product as well as migrate from WLM to gWLM.

    Getting started with gWLM (2004 - 2005)
    Created paper to guide new users through setting up gWLM to accomplish several common tasks.

    Getting started with HP-UX Workload Manager (basic configuration and monitoring) (2003 - 2005)
    Created paper to guide new users through setting up WLM to accomplish several common tasks using the configuration wizard.

    Using WLM: a Quick Reference (2002 - 2005)
    Developed white paper to explain how to complete common WLM tasks as well to present an example WLM session highlighting major features of the product.

    Resizing nPars automatically with HP-UX Workload Manager and iCOD (2004 - 2005)
    Created paper giving a step-by-step process for migrating CPUs between nPars (hard partitions) using WLM.

    Resizing vPars automatically with HP-UX Workload Manager (2003 - 2005)
    Created paper giving a step-by-step process for migrating CPUs between vPars (virtual partitions) using WLM.

    More efficient high availability through manageability (integrating Serviceguard and HP-UX Workload Manager) (2003 - 2004)
    Created paper explaining how to integrate Serviceguard and WLM to optimize resource utilization when applications are moved between systems.

    Using HP-UX WLM Effectively with Your Most Critical Applications (2001 - 2005)
    Updated the WLM Oracle Database Toolkit paper to include newly developed toolkit products.

    HP-UX Workload Manager Oracle Database Toolkit product brief (2001)
    Created brief to quickly introduce sales representatives and customers to the new toolkit.

    HP-UX Workload Manager Overview (2001 - 2004)
    STC Award of Merit, 2003

    Updated the paper making it more solutions-oriented, enumerating several solutions the product provides to customers, then maintained the paper.

    Process Resource Manager Overview (2000 - 2007)
    Updated the paper to improve readability and flow, then maintained the paper.

Web sites

    www.hp.com/go/wlm (2001 - 2004)
    Maintained WLM product's customer web site and posted numerous example configuration files for easy customer access.

    www.hp.com/go/prm (2001 - 2007)
    Maintained PRM product's customer web site.

Manual pages (UNIX)

    gwlm command (2004 - 2007)
    Syntax and usage information for the gwlm command.

    WLM overview (2000 - 2005)
    Overview of the features and commands of WLM plus a "How to use WLM" section.

    wlmd command (2000 - 2005)
    Syntax and usage information for the WLM daemon, wlmd.

    PRM overview (1998 - 2007)
    Overview of the features and commands of PRM plus a "How to use PRM" section.

    prmrun command (1998 - 2007)
    Syntax and usage information for the prmrun command.

Training

    HP-UX Workload Manager Version 1.0 Beta (2000)
    Developed PowerPoint-based WLM training for support and sales staff.

    HP Process Resource Manager Version C.01.07 (1999)
    Updated training.

    HP Process Resource Manager Version C.01.06 (1999)
    STC Award of Merit, 2000

    Developed PowerPoint-based PRM training for support and sales staff.

In-house documents

    Documentation lifecycle (1999 - 2007)
    Explained the process of writing documentation from the beginning of a project through completion.

    Structuring Documents with FrameMaker+SGML (1997)
    Updated the Structuring Documents with FrameBuilder manual for use with FrameMaker+SGML and a new set of templates.

    Structuring Documents with FrameBuilder (1995)
    Being one of the first writers in my department to master the process of taking an unstructured document into FrameBuilder, structuring it, and then producing SGML, I developed this HTML manual to assist other writers in the conversion process. The manual includes the process, list of available tools, an error message catalog, and a list of tips on how to produce properly formatted SGML documentation.

    Quality Assurance Process for SGML Books (1995)
    Teamed with an editor and another technical writer to develop a detailed checklist enumerating items to examine when reviewing an SGML book for accuracy and consistency in formatting.