Clear, accurate API documentation is essential for developers building modern software. As part of a 14-week specialization with the University of Washington, I developed skills in creating developer-focused content using docs-as-code principles. 

Below are public samples showcasing my ability to explain APIs clearly and effectively, from onboarding t reference topics. 

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.

Gives  users complete context  to understand API use case and design effective solutions. 

[View Source on Github]

My Overview topic serves 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 is to provide necessary context to help developers understand the API's purpose, its primary use cases, and the problems it aims to solve.

Fast tracks new users with the minimum steps needed to get up and running.

[View Source on Github]

 My  Quickstart guide serves to enhance the overall developer experience by providing a positive first interaction with the API. My goal is to deliver a concise, easy-to-follow guide that helps Developers make a simple first call to the API.

Provides developers with precise, up-to-date technical detail to integrate products successfully.

[View Source on Github]

My reference information details the API’s resource, endpoints, methods, query parameters, request and response data formats. My goal is to  help developers quickly look up specific resources or endpoints without needing to go through lengthy tutorials or examples.

Walks users through real-world scenarios, helping them learn by doing. 

[View Source on Github]

My Tutorial demonstrates a  real-world use case and shows  developers who learn by doing how to implement it. By providing detailed guidance with code examples, my goal is to help developers understand and use the full capabilities of the API.