<< Go Back

Writing Porfolio

This part of my portfolio provides samples of documentation that I have written or updated. I have also organized this documentation in several different ways to help you get an idea of my progression and processes as a writer.

You can browse by work experience, chronologically, and by the type of writing tool used.

Tool Used Order

These writing samples are arranged according to what tool was used to create the document. I do not have the source files, but you can see the result from using that tool in the final document. You can download some documents for viewing or printing on your own computer (right-click and choose Save As), or you can view them in your web browser if your browser and operating system allow that. Just click on the icon for the format you want.

Tool	Document	Explanation
Word Processor (usually Word)	Newspaper TechRelief Column	Contributed short columns about how to use and understand technology to my local newspaper, every other week.
	CEP Questionnaire	Form-fillable questionnaire for customers who have recently purchased the product and need to plan for how to implement it. This is also used in conjunction with the customer support team.
	Midrange Tech Talk	Wrote short tip article for trade magazine about the new advisors for the lastest software release.
	AS/400 Submission (unpublished)	Wrote a short piece on peer-to-peer networking for NextPage and the technology in general. Piece was not accepted for publication because the magazine changed formats.
	Midrange Article	Wrote article about how to use the LPAR Planning Worksheets. Focused on teaching the worksheets.
	AS/400 Article	Wrote article about how to use the LPAR Planning Worksheets. Focused on teaching about logical partitions.
RoboHelp	BYU "Using RoboHelp" Online Help	Developed this online help file as a way of teaching other technical writing students how to use RoboHelp to create online help.
	Uinta "Pinnacle" Online Help	Software for banks that needed online help. I worked with users to find out how they used the existing software so that I could provide the appropriate help in the right places to make their jobs easier.
	Captiva FormWare 5.1 File System Help	Edited Scan section for accuracy. Changed INI style (in Supplementary Information section) to make the table more readable.
HTML Tool (like HomeSite, Notepad, Dreamweaver)	IBM LPAR Hardware Planning Guide	Took information out of Planning document and expanded it. Added new hardware and configuration options. Made the guide easier to access by using lots of tables and figures.
	IBM V4R5 Planning	Updated existing documentation with new information. Added an online Advisor to aid in planning.
	IBM V4R5 Troubleshooting	Got rid of useless Backup and Recovery document that was a repeat of other books, and focused instead on troubleshooting. Created an online Advisor to make searching easier.
Framemaker	NextPage Site Design	Some of this information was in an old manual in Framemaker. I had to update the information and reorganize it (and add to it in places where it was inadequate) in XML format for online use. (HTML version no longer available as company has taken down the docs.nextpage.com site).
Madcap Flare	Single Topic Staff Help for CEP	Had to arrange complex help and instructions to display on a single page per product manager requirement. Used lots of linking and consistent structure to make it easier to access the content.
	Mobile for Horizon Help	Help for a mobile app. I created the basic structure and organization.
	Horizon Help	Updated existing content. Moved project from FrameMaker to Flare using import rules and templates.
	Enterprise Admin Help	Worked with other writers to create organization and initial content. Maintained content over the course of 2 releases.
	Data Flow Diagram	Worked with architects, support, quality assurance, product manager, and engineers to get the initial content and to update each release based on changes or additions. Had to map out the interactions using Visio and to arrange in a way that was readable in a small page space.
	BLUEcloud Analytics Getting Started Guide	Gathered content from interviews with Dev-Ops team.
	BLUEcloud Analytics Data Reference Guide	Received technical details from software engineering and had to turn it into a customer-focused form. Needed knowledge of analytics as well the enterprise-level products of the company. My experience with all the teams was thus quite valuable in this case.
	Web Services (Symphony ILS) initial version SDK: current version SDK: current version Admin Help: current version Setup Guide: current version Release Notes:	Created the documentation from scratch for the Web Services product. This included an installation guide, Admin help, and an SDK. Initially, we started with an SOA architecture that used SOAP or REST protocols. Later on, we moved to an ROA framework with REST. We also then moved to the use of Enunciate for getting the examples and comments from the code and putting them into a JavaDocs-style format.
Acrobat	IBM LPAR Hardware Planning Guide	Took information out of Planning document and expanded it. Added new hardware and configuration options. Made the guide easier to access by using lots of tables and figures.
Adept	IBM V4R4 Planning for and Setting up Logical Partitions (Hardware section)	I finished my assignment early, so I was asked to contribute hardware information to a section of this document.
	IBM V4R4M1 Planning and Setting Up Logical Partitions	Took over this document from previous writer. Added graphics and sample configurations to make the information easier to understand.
	IBM V4R4 Backing and Recovering Logical Partitions	This document was the result of a very rapid development cycle where I had to come in and learn unfamiliar hardware and software, learn a new style guide, and a new writing tool (SGML), all while trying to document the new software. I finished ahead of schedule.
	IBM LPAR Hardware Planning Guide	Took information out of Planning document and expanded it. Added new hardware and configuration options. Made the guide easier to access by using lots of tables and figures.
	IBM V4R5 Planning	Updated existing documentation with new information. Added an online Advisor to aid in planning.
	IBM V4R5 Troubleshooting	Got rid of useless Backup and Recovery document that was a repeat of other books, and focused instead on troubleshooting. Created an online Advisor to make searching easier.
Epic	NextPage Content@ Administrators Guide	Initially written by software engineers. Reorganized and applied corporate style to this guide.
	NextPage Content@ Deployment Guide	Worked closely with engineers, QA, consulting services, and support engineers to coordinate all the information.
	NextPage Lotus Notes Content Adapter	This documentation was praised by users and salespeople alike as easy to read and comprehensive. Included more links and technical detail than commonly done in other existing documentation. (HTML version no longer available as company has taken down the docs.nextpage.com site).
	NextPage Site Design	Some of this information was in an old manual in Framemaker. I had to update the information and reorganize it (and add to it in places where it was inadequate) in XML format for online use. (HTML version no longer available as company has taken down the docs.nextpage.com site).
	NextPage Matrix	Only responsible for a couple small articles. The assigned writer got swamped with work, so we all took over portions of the entire document to help him out. (HTML version no longer available as company has taken down the docs.nextpage.com site).
	NextPage Content Network Manager	Given responsibility for this set of documentation soon after previous author left company. Had to become familiar with software and update documentation to meet style guidelines. (HTML version no longer available as company has taken down the docs.nextpage.com site).
	NextPage Master Glossary	Took all existing, and sometimes contradictory definitions in all documentation and put everything together in one location. Also designed links in the documentation that generated small pop-up window definitions for instant access to a word. (HTML version no longer available as company has taken down the docs.nextpage.com site).