Kate Domenichella

Bridging complex technology and real people through clear, thoughtful documentation.

Portfolio

Welcome to my technical writing portfolio!

My portfolio features the following technical writing pieces:

  • iOS Shared Device User Guide
  • Android Personal Device User Guide
  • Desktop Device User Guide
  • User Training
  • Release Overview
  • Tri-Fold Brochure
  • System Architecture Diagram
  • Version-Specific Changelogs
  • Device-Specific Changelogs
  • Customer-Specific Changelogs
  • New Feature Videos
  • Training Videos
  • Doc Package

Background Information

At MH, our software is built on four devices: iOS phones and iPads, Android phones, and Windows desktop. We must know and be able to write about each device.

When I started at MH in January 2018, the original documents were in PPT format. These PPT documents were quickly assembled by project managers when asked by customers for user guides. The Technical Documentation team had not been established yet. The Technical Documentation team began in mid-August 2017 with the hiring of a tech docs manager. 4 months later, I joined the manager and was assigned the user guides.

I migrated all content from the 5 PowerPoint presentations into MadCap Flare. While doing the migration, I had to rewrite most of the content and add in many missing features. I kept the user guides up to date for the 14 months until we hired an entry-level technical writer to learn the user guides. I have continued to mentor the new tech writer on user guides since she began in March 2019.

Writing Pieces

iOS Shared Device User Guide

The iOS Shared Device User Guide (PDF|HTML) is from our MH-CURE 19.3 release.

Android Personal Device User Guide

The Android Personal Device User Guide (PDF|HTML) is from our MH-CURE 19.3 release.

Desktop Device User Guide

The Desktop Device User Guide (PDF|HTML) is for a brand new version of the MH-CURE desktop platform. MH is in the process of sunsetting the legacy version of the MH-CURE desktop. This version of the Desktop is vastly different than the legacy version, and all content had to be written from scratch.

User Training

 

Release Overview

 

Tri-Fold Brochure

 

System Architecture Diagram

 

Changelogs

At MH, we deliver version-specific changelogs for each software release. These changelogs include new features, improvements, bugs fixed, and known issues. These HHUS tickets are tracked using a specific 5-digit number in Jira. We document the iOS, Android, Desktop, and Admin/Server updates.

Version-Specific Changelogs

We provide a version-specific changelog for each software release. We do not provide the changelogs on the cloud, but we do display the Flare-built version in HTML and PDF.

Screenshot on HTML:

<<IMAGE>>

Screenshot on PDF:

<<IMAGE>>

Device-Specific Changelogs

Each software release changelog is conditionalized by the device type in Flare. If a customer asks for an iOS-only changelog for a particular release, I can easily build that for them. We do not provide this type of changelog on the cloud, but we do generate PDF versions when requested.

<<IMAGE>>

Customer-Specific Changelogs

Customer-specific changelogs are used to show what has changed in the customer’s environment from one release to the next. For example, a customer was on version 19.1.0 and wanted to upgrade to version 19.3.0. The changelog would include everything updated in 19.2.0 and 19.3.0.

<<IMAGE>>

New Feature Videos

These videos are created for any new features for a specific release. All videos are made using Premiere Pro and I record all voiceovers through GarageBand.

  • New Features and Improvements (2:15)
  • Alerts (2:12)
  • Patients (0:54)
  • Dynamic Roles (0:32)
  • New Features Training Video (6:22) | This video is the first four videos combined.

Training Videos

These training videos are based on the new Desktop Device User Guide. The request was made to teach users through videos how to use the new desktop device. I made X standalone videos and then combined all videos into one cohesive video using Premiere Pro.

  • List of the videos w/ hyperlinks
  • Same
  • Same
  • Same

Doc Package

This is a doc package. At MH, we use doc packages to wrap up all content for a specific release. It is designed to be a “plug and play” system. Since all links are cloud-based and secure, links work anywhere, at any time. This allows our customers to put the short URL on their intanet page and end-users (doctors, nurses, staff) can access MH’s version-specific content at any time.