API documentation
One of my first jobs as a technical writer at xMatters was working on the API documentation, having never used an API before. I quickly got up to speed, and was soon testing out calls using Postman and Insomnia and writing code samples to help showcase the endpoint structure.
Online help
The purpose of this topic (like the project it was written for) was to make the technical accessible to less technical users. This was written for the launch of the Flow Designer component of xMatters. I was responsible for most of the original documentation for the feature.
How-To Videos
Storyboarded, captured and edited the video / screencasts and background sound, using Captivate, Premiere Pro, After Effects and Audition. If I had to do it all over again, I would not use that music for one thing.
In-app guides
As the product manager for our Free tier, I became responsible for planning, drafting, implementing and monitoring our in-app guides. I also performed A/B testing on effectiveness in regards to key action and user engagement.
Sorry, no live samples since they’re in the product.
Super technical content
Researched the subject matter, reading through protocol and design documents to figure out what users familiar with the protocol (the only people who should be delving into it) would need to know. Developed the content based on this research…and yes, for a while, I did understand how to parse M-Bus hex telegrams.
christine astle 