/plushcap/analysis/mux/mux-building-better-docs

Building better docs

What's this blog post about?

Mux has launched a new documentation site, docs.mux.com, to enhance the developer experience (DevEx). The company realized that its previous documentation site was not sufficient for its goals and ambitions in 2021. As an API company, Mux considers documentation as a core part of its product. The development process involved user testing, content quality improvement, usability enhancement, terminology simplification, and style guide creation. The new docs site features improved search functionality, clearer terminology, and a more intuitive layout for better navigation between Mux Video and Mux Data documentation. Mux used the Next.js framework to build the frontend application, Algolia for search, and SwaggerParser to parse its OpenAPI v3 specification for generating API reference documentation. The company encourages feedback from users to continue improving their developer experience.

Company
Mux

Date published
March 30, 2021

Author(s)
Dylan Jhaveri

Word count
2401

Language
English

Hacker News points
None found.


By Matt Makai. 2021-2024.