SOP: Software Release Documentation Workflow

Before I created this workflow, there was no formalized process for communicating information from the product team to the customer-facing teams. Because of this, Marketing rarely received the information they needed in time. Sometimes, the VP of Marketing had to go into the software and explore each feature to get the information they needed.

Guidelines: Generalizing Proposal Content

These guidelines are used to generalize content that was used in a specific proposal. Once the content was scrubbed of information pertaining to a specific bid, it was added to the Loopio content database. 

Process: Prepare Proposal Content for Loopio

The company had many duplicate entries in their content library, and new content from SMEs or software releases was added to the library without going through the proper reviews. This process provides an overview for reconciling new content with existing library entries.

Content Architecture Structure

I was tasked with redoing the content navigation architecture for a MadCap Flare library. Most of the content existed in 3 long documents that needed to be broken down to smaller topics. In addition to designing the architecture, I determined what content existed, needed to be expanded on, or was missing.

Template: JIRA Bug Ticket

Bug tickets were frequently submitted without the necessary information to replicate the bug, so I created a template detailing all of the information needed in a bug ticket. I included several examples of bug tickets that provided the necessary information.

Back to Top