•  Millions of software developers depend on API (application programming interface) documentation to successfully develop their software projects. The ability to effectively communicate how to use an API is crucial.
• I chose to pursue a 14-week specialization in API documentation at the University of Washington to deepen my expertise in this essential area of technical writing.
• This program has equipped me with advanced skills in creating clear, concise, and user-friendly API documentation that meets the needs of developers and stakeholders.
• I've gained a thorough understanding of what it takes to write great API documentation, and I have a portfolio project to showcase my skills. See samples of my work below!

The following writing samples are publicly available examples of technical documentation that I've written. These samples represent just a small portion of my professional technical writing, as much of my other work has been proprietary and is protected by non-disclosure agreements.

As part of the University of Washington's API program, I was tasked with documenting a web service designed by a peer. The following writing samples are part of the REST API documentation that I created for an imaginary, simulated web service called Chauffeur Tracker.

I collaborated closely with my peer SME to research requirements and understand use cases and workflows.

Using Markdown, I created the documentation and managed the source files in GitHub, adhering to the docs-as-code methodology. 

I tested the API collections with Postman and cURL and conducted usability tests on critical topics.

My work underwent a rigorous peer review and editing process before being published as a GitHub Pages site.

Overview

• Docs-as-code Tools used — Git, GitHub, Markdown
• API Test Tools used — Postman, cURL

Set in the context of my Chauffeur Tracker web service documentation, I wrote this Overview topic as an entry point for developers, giving them a clear understanding of what the API does and how it can be used in their projects. My goal was to provide necessary context to help developers understand the API's purpose, its primary use cases, and the problems it aims to solve.

Overview - published on GitHub Pages
Overview- on GitHub

Quickstart

• Docs-as-code Tools used — Git, GitHub, Markdown
• API Test Tools used — Postman, cURL

Set in the context of my Chauffeur Tracker web service documentation, I wrote this Quickstart guide to enhance the overall developer experience by providing a positive first interaction with the API. My goal was to deliver a concise, easy-to-follow guide that helps Developers make a simple first call to the API.

Quickstart - published on GitHub Pages
Quickstart - on GitHub

Tutorial: Enroll a driver

• Docs-as-code Tools used — Git, GitHub, Markdown  
• API Test Tools used — Postman, cURL

Set in the context of my Chauffeur Tracker web service documentation, I wrote this Tutorial to demonstrate a  real-world use case and show  developers who learn by doing how to implement it. By providing detailed guidance with code examples, my goal was to help developers understand and use the full capabilities of the API.

Enroll a driver - published on GitHub Pages
Enroll a driver - on GitHub

Reference: drivers resource

• Docs-as-code Tools used — Git, GitHub, Markdown
• API Test Tools used — Postman, cURL

Set in the context of my Chauffeur Tracker web service documentation, I provided reference information about this API’s resource, endpoints, methods, query parameters, request and response data formats. My goal was to  help developers quickly look up specific resources or endpoints without needing to go through lengthy tutorials or examples.

drivers resource - published on GitHub Pages
drivers resource - on GitHub