Helping people write better technical API documentations with a collaborative approach.

https://youtu.be/9WD4ODp60jE

Background

Based on our interactions with technical writers, developers, and members of our own team, we figured out that documentation isn’t broken because of tools. it’s broken because no one owns it.

We understood the gaps and found a few ways to bridge them.

Through conversations with writers, developers, and our own team, we realised that tools don’t break documentation, lack of ownership does.

Once we understood that, we could clearly see the gaps and start fixing them.

My Role

Product Designer

Team

1 Designer, 3 Engineers, 1 Manager

Duration

2 Months (for MVP)


Research & Findings

As part of the research exercise, we contacted writers, developers, and managers. Some shared negative feedback about existing tools in the market, while others mentioned why they don’t document.

image.png

Technical writers

Writers bring clarity, but can’t write without collaborating with developers or product managers.

image.png

Developers

Devs hold the accuracy, but don’t see documentation as part of their job. They just move on to the next sprint.