Text analysis software home page

Project description and scope

In this project, I documented a textual analysis software tool. I was the first writer to work on this project, so I interviewed subject matter experts, created templates, developed a project plan, and delivered five separate guides totaling more than 250 pages for audiences ranging from system administrators to end users.

Output types and deliverables

The finished project included several PDF files including an administration guide, two user guides, an installation guide, and release notes.

Tools used

I designed the project in Framemaker 7.0 and Photoshop CS2. I used SnagIT 7 for screen captures, and Photoshop for image manipulation. I wrote and edited content in Framemaker, and created PDF files using Adobe Distiller.

Skills showcased

I was the first writer to work on this project, and we released the product about four months after I started working for the company. I had to work quickly to understand a new application well enough to provide complex documentation targeted at a wide range of users with fast turn around.

This sample also shows my ability to design project layouts using Framemaker, and document a web-based application.

Writing sample information

The sample included here is a chapter in one of the user guides, aimed at helping end users with the application's home page.

This document is designed for public release, but for security purposes, I have removed information that would identify the products or company involved. 

To read the section in its entirety, view the PDF file.