Articles

What is the importance of aligning UX and technical writing practices, especially as generative AI becomes part of the developer experience? Through practical examples, we argue that shared ownership of UX and technical writing is crucial to build AI-ready, future-proof developer portals.

A strategic, well-structured approach can enhance your content’s usability, discoverability, and value for both developers and AI tools. In this article, we outline five practical steps, from prioritization to metadata strengthening, to help make your content AI-ready.

What is AI-ready, structured content on your developer portal? We explore the importance of a solid content strategy, examples for semantics in narrative docs, then break down the investment needs of various structured content formats.

A large, Netherlands-based financial services provider partnered with Pronovix to improve its developer portal’s UX and content structure. The Techwriters introduced API flow guides, refined onboarding, and ensured better content organization for lasting improvements. This article explores the challenges encountered and how UX and technical writing expertise can make a difference.

Excellent OpenAPI specifications enable developers to gain clarity on data structures and responses, while automation tools leverage these specs for better code generation and testing, reducing manual effort. In this article, we share some best practices and highlight the essential elements for a better OpenAPI specification.

We explored free and open-source API documentation solutions, and compiled the results of our research in this post.