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.
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.