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.
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.
Document I wrote for CloudBees newest app integrations geared specifically towards creating a developer-centric workflow. I was the lone writer on this project.
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.
Document I wrote to guide developers in setting up GitHub App authentication to Jenkins. This feature was created in the OSS community and I based my documentation on the documentation the OSS developer created here: https://github.com/jenkinsci/github-branch-source-plugin/blob/master/docs/github-app.adoc