top of page
Laptops

Case Studies 
& 
Solutions

MadCap Flare

Documentation Specialist

Situation: What Company? McMurrey Associates

This SAMPLE document includes recommendations I made on a short unit called Apply Settings to the Primary Table of Contents (TOC), which included: ​

  • Updating screen captures (where needed)

  • Updating the wording for users to understand

  • Adding comments (see right side of the document)

 

​

Adobe FrameMaker

Documentation Specialist/Content Reviewer

Situation: What Company? McMurrey Associates

There were some major content updates in Adobe FrameMaker, which resulted in outdated content being taught in all units. I updated all the screen captures and recommended updates using track changes in MS Word. This SAMPLE document includes recommendations and updates I made on a unit called FrameMaker Variables & Conditional Text, which were based on: 

  • Applying revisions using track changes in MS Word

  • Updating screen captures

  • Updating the wording for users to understand

  • Adding comments (see right side of the document)

 

In addition, the updates for this unit have been published and can be viewed here:

FrameMaker Variables & Conditional Text

​

Confluence Collaboration Tool 

Content Creator (Confluence)

Situation: For McMurrey Associates, there was a need for lessons on the Confluence collaboration tool to be developed, but included zero content. The attached DRAFT document provides a sample of content I created on a particular unit in Confluence, named Unit 2, Creating and Editing Pages and included screen captures using Microsoft Word for the reviewer (instructor) to see. 

The sections covered in this unit show users how to:

  • Add a new page in Confluence

  • Add child pages in Confluence

  • Add header images to a page 

  • Format text on a main and its child page(s)

  • Add child pages at different levels

  • Change text colors

  • Add bullets 

  • Add a page status 

 

Note: This course is still being developed. 

Technical Writing Modes Course (In-Progress)

Documentation Specialist/Reviewer

Situation: For McMurrey Associates, there is currently a need for some exercises in the Technical Writing Modes course to be reviewed for accuracy. The attached DRAFT document provides a sample of a written exercise I reviewed and made recommendations on called Subject-Verb Agreement Exercise.  

The recommendations I made were based on: 

  • Applying revisions using tracked changes

  • Applying version control (see footer)

  • Adding an exercise title  

  • Adding comments (see right side of document)
     

Note: This course is still being developed. 

bottom of page