All work

Kestrel CLI docs

Documentation for a deploy CLI. I restructured the docs around real tasks, designed the site, and built it with search and copyable examples.

Year

2022

Role

Docs site + front end

Client

Kestrel

Timeline

7 weeks

What changed

01

01

Docs organized by task, not by command

Docs organized by task, not by command

02

02

Search that finds flags and examples

Search that finds flags and examples

03

03

Every example copyable and tested

Every example copyable and tested

The problem

The docs listed every command alphabetically. New users knew what they wanted to do, but not which command did it.

What I changed

I reorganized the site around tasks like deploying a preview or rolling back, with the reference pages kept one click away.

Laptop on a blue rug showing a playful blue and cream website

Examples that work

Every example runs in CI before each release, so copied snippets always match the current version of the tool.

What I learned. People look for the task they want to finish, not the command name. Organising the docs around tasks cleared up most of the confusion.

What happened

Support requests about basic setup went down, and the docs became the most visited part of the site.

Have a problem like this?

I take on two or three projects a quarter. Tell me what’s slowing your team down and I’ll reply within a day.

Create a free website with Framer, the website builder loved by startups, designers and agencies.