API docs

I have created a lot of documentation for developers over the years. From 2023 to present (2025), I have taken an established software company with a complex set of APIs from having no API documentation to having a robust and detailed API reference for each API. This documentation has increased company revenue by attracting new customers and also helping to retain existing customers who demanded documentation for the APIs.

Please browse the following sections to see examples of things I’ve done in the areas of API docs, Docs-As-Code tools, github versioning and deployment, jekyll, and sphinx.

Github site example

To further demonstrate my capabilities to work with modern developer doc tools, I used github to build, edit, version, and deploy this portfolio site that you are currently viewing.

Docusaurus example

I've also created a separate portfolio site to demonstrate my capabilities with writing, editing, styling (CSS), building, and deploying Docusaurus sites. I store and version my Docusaurus content in github, where I also host the site. At this time, the Docusaurus portfolio includes only a subset of content from this full portfolio you're currently viewing.

Postman example

To demonstrate my capablities for building API documentation with the Postman Collections tool, I created the following small sample doc sites:

Jekyll example

I've also built an example of a developer style of site with jekyll. I built the site in a github repo and hosted it on github pages. You can see it here.

Madcap Flare example

If you use Madcap Flare to create your Help content, you might also want to use Flare to create and maintain your API documentation. Here are two API reference examples that I created with Flare. I built these in a github repo.

  • You can see an example with a two-column format here.

  • You can see an example with a three-column format here.

OpenAPI example

I created an API documentation site on github that uses data from the Swagger PetStore Sample API. I built the site with the highly respected and most commonly used specification: OpenAPI. I'm very experienced with CSS, so I can style sites like this to fit any branding and format that a company needs. You can see this site here.

Sphinx site example

I have a similar portfolio site that I built with sphinx to demonstrate what I can do with that tool.

Note: I haven’t hosted this site anywhere yet. But I’ll be happy to show it to anyone who asks!

API course certificates

Also, here are certificates for a few of the API courses that I’ve completed.

LinkedIn profile

This portfolio is just a small sampling of what I have done and what I can do. If you would like to see more examples or have any questions, feel free to contact me via my LinkedIn profile.

See my profile on LinkedIn.