All case studies

Making Streams documentation task-focused

ElasticTechnical documentation

A refactor of the Elastic Streams documentation, replacing a product-centric structure with one focused on user needs.

The challenge

The Streams documentation needed a structure that helped readers understand the product and find the information relevant to their work.

What I did

Changed the organizing principle

I refactored the Streams docset as a whole, moving from a product-centric approach to a structure focused on user needs.

The outcome

A reorganized docset that presents Streams through the needs of its users. The published documentation is available as a writing sample.

Live documentation is maintained collaboratively and may have changed since this contribution.

View the work

Explore more case studies

Let’s talk about
your documentation.

Get in touch about senior and principal technical writing roles, documentation projects, or an exchange of ideas.