As part of my first major feature documentation assignment at Kong, I was asked to document a feature that had been a part of the codebase for a while but was lacking documentation and so not used. The developer who wrote the feature was no longer at Kong, so I had to rely heavily on his notes and PR where he added the new code. Using his notes and the code in the PR, I was able to create a reference doc (also included in my sample writings) as well as several example use cases that I tested myself as I documented them.
I participated in Google's Season of Docs in 2021 by contributing to Redocly's open source documentation. One of the main pieces I worked on was adding a Redoc quickstart guide. I also added some deployment guides on how to integrate Redoc with React-based projects and using the CLI to run Redoc locally.
My first 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 document written by a developer and tested the endpoints with Postman and curl to create my sample requests. I also created a page on how to authenticate with an API token.
This document includes my experience with, thoughts on, and examples of my UX writing. As a technical writer I am often asked to either provide or review and edit the text for the user interface. I have experience working directly in Figma, or even making comments in the code in GitHub.
At MuleSoft, I worked with a large team of writers and was able to develop my collaboration skills. I was assigned to document a new API Gateway with another writer. There was a lot of content to cover, so while we worked together to outline what content was needed and how to organize it, we split the writing tasks between the two of us. After writing we reviewed each other’s content and approved open PRs so the content could be merged. It was nice to have a different perspective and it helped me to grow as a writer and team member.