---
title: 'How to assist API design as a technical writer'
date: 2021-10-12
lastmod: 2021-10-12
last_updated: 2021-10-12
doc_version: '2021-10-12'
description: 'The programmatic equivalent of UX Writing is API Design. The words that you use to describe your API enable conversations between software and people - it’s just a bit more structured and mechanical. That’s why technical writers are uniquely suited to assist technical teams in doing API design, especially when an API First design approach is being followed. '
canonical: https://passo.uno/posts/how-to-assist-api-design-as-a-technical-writer/
---

# How to assist API design as a technical writer

The programmatic equivalent of UX Writing is API Design. The words that you use to describe your API enable conversations between software and people - it's just a bit more structured and mechanical. That's why technical writers are uniquely suited to assist technical teams in doing API design, especially when an API First design approach is being followed.

<!--more-->

The above is the abstract from my talk _When documenting is designing: How to assist API design as a technical writer_ from [Write the Docs Prague](https://www.writethedocs.org/conf/prague/2021/ "WtD Prague").

Here are the [slides](https://docs.google.com/presentation/d/10Lu22bMTj2v15-OvXYWmFyKLxrB6tm7p/edit?usp=sharing&ouid=116190961458837834325&rtpof=true&sd=true "slides"). And here is the video:

{{< youtube ODjX_3tGeeM >}}

---

Canonical HTML version: https://passo.uno/posts/how-to-assist-api-design-as-a-technical-writer/

## Sitemap

- [Full post index](https://passo.uno/sitemap.md)
- [llms.txt](https://passo.uno/llms.txt)