About Me
Hi, my name’s Mike and I’m a technical communicator.
I help companies make their products and processes more accessible, engaging, and easier to use. With over 15 years of experience in technical communication, I’ll work with you to bridge the gap between engineers and end users by simplifying complexity and delivering a quality user experience. I aim to lead teams that consistently deliver content that is timely, relevant, and useful to all users.
Writing Samples
Product Integration Guide
How to Integrate Release with the Platform
This topic describes a complex process required to integrate one of Digital.ai’s products with the central Digital.ai Platform.
I was solely responsible for writing, organizing, and editing this content. I worked closely with developers throughout the writing process to ensure technical accuracy, and with Product Managers for each product to ensure overall usability.
The guide was written in Markdown and publushed by Docusaurus.
API User Guide
This collection of topics explains how to use one of Digital.ai’s public APIs, and is aimed primarily at developers. Everything listed under Policies API Guide in the TOC is considered part of the sample.
I was solely responsible for writing, organizing, and editing all of this content, including the code samples (which I wrote and tested via Postman). I worked closely with developers throughout the writing process to ensure technical accuracy, and with the Product Manager and QA engineer to ensure overall usability.
The guide was written in Markdown and published by Docusaurus.
API Reference
This is a detailed API reference topic for the API mentioned in the previous sample. I wrote all of this content including the code samples. As with the previous example, developers and QA engineers on my scrum team are an invaluable resource in all my API writing.
The majority of content is written as RST (reStructured Text) comments inside python source files. We use Sphinx to pull out the doc content, compile it into topics, and publish it as static HTML.
Conceptual Info
This topic provides an in-depth explanation about what policies are and why you’ll use them. I rewrote and reorganized this topic based on content that existed from before I started with the company. The only parts that I didn’t rewrite entirely (except to edit for consistency) are: Policy Status and Policy Evaluation.
This was written in Markdown and published by Docusaurus.