This is a get started guide I created for Redocly's new suite of products using the cloud-based editor, Reunite. I completed several user testing sessions with this guide, and used the feedback to make it better each time.
This is a newsletter I wrote for Redocly when we announced our new suite of products. I wrote everything except for the introductory paragraph. I also curated the articles from our blogs and other API news sources.
At StackHawk, I was asked to write an end-to-end tutorial for our GitHub integration. This tutorial needed to be simple to implement, removing all barriers of entry so anyone could complete it. I created a tutorial that guides the user through the entire process and does not require any downloads or environment configurations. Afterwards, I was told to add some 'KaaKaww', applying the same voice as in other areas of the product.
My second piece of API documentation. I created a template for how to organize the content based on Tom Johnson's assertion that reference documentation for API endpoints consists of 5 general sections: resource descriptions, endpoints and methods, parameters, sample requests, and sample responses. I took a previously published doc page and tested the endpoints with Postman and curl to create my sample requests.
For one of my first major projects at Kong I was asked to document a feature that was part of the codebase but not yet included in the documentation, and therefore not really usable (docs are important!). The developer who wrote the feature was no longer at the company, so I had to rely on the PR he wrote and some notes he left behind. Using his notes and PR, including the schema and subschema for the different handlers, I was able to create cURL requests and generate sample responses.