Writing Samples: OpenService

At OpenService, I was the sole technical writer for five years. Occasionally I supervised a contract writer or two, but generally worked alone. I learned a lot during my tenure at OpenService. I was able to play in the lab and learn a fair amount about setting up and installing the software I was documenting. I took over the documentation for a product that once had 12 writers working on it, and then there was just me. I taught myself FrameScript to automate PDF and HTML-based help production so that instead of a manual, error-prone, multi-hour process, I could press a button and get all my output in an hour.

Monitoring Events with Security Threat Manager

Audience

Monitoring Events with Security Threat Manager is intended for anyone using Security Threat Managerâ„¢ (STM) to monitor network and security events.

Administrators should be familiar with the following:

  • the security policies and procedures of your environment
  • the organization of your network
  • the configuration of your STM installation

Operators should be familiar with the following:

  • the security procedures of your environment
  • basic web browsing
  • the STM Console
Purpose

This guide describes how to use the Active Alert, Historical Alert, and Reporting modes for STM, including instructions for SOC and NOC administrators to configure alert views and reports and for SOC and NOC operators to monitor events.

Notes

This manual is presented as a PDF for users to print if they require it.

View the PDF.

This book was awarded an STC Boston Award of Merit in 2005.

Software Tools Used: Adobe FrameMaker 7.0, Adobe Acrobat 7, Adobe PhotoShop 6.0

Evolution of a Template

Audience

This template is intended for every technical writer working for OpenService, Inc.

Purpose

This is a living document that is both the template and style guide for OpenService.

Notes

Original Template PDF (2002)

Current Template PDF (2006)

Company confidential material has been removed, so page numbering is not sequential.

Software Tools Used: Adobe FrameMaker 6.0, 7.0, Adobe Acrobat 5, 7

WebWorks Help Template

Audience

This template is intended for every technical writer working for OpenService, Inc.

Purpose

This is a sample WebWorks help template, based off of the OpenService FrameMaker template, which tests all the paragraph formats and how they transfrom from FrameMaker to WebWorks.

Notes

All OpenService online help was created by converting the FrameMaker manuals to WebWorks Help. These sample show how the style of the help pages.

View the HTML-based help.

Software Tools Used: Adobe FrameMaker 7.0, Quadralay WebWorks 2003