Articles
Everything on developer portals from strategy and business to technology and visual design.
Sign up to our newsletter to make sure you don't miss out.
Struggling to get buy-in? Ten ways to make the business case for content improvements
Economic buyers may not be fully aware of the business value of quality content, and you need to explain in detail to get budget approval for your developer content improvements. This article outlines common concerns and provides business-focused arguments to resolve them. We emphasize that content quality impacts trust, speed, and user experience, it will ultimately affect business goals like adoption and retention. This article is for you if you want to learn to frame content improvements in terms of business impact, and to collaborate with relevant teams to measure and demonstrate success, even with limited resources.
Technical Writer Case Study on a Global Financial Solutions Provider
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.
by 1 year 11 months ago
Elements of a well-structured OpenAPI Specification
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.
The intricacies of team and project management in technical writing
Why is it essential to establish a clear documentation workflow? How can developers, project managers (PMs), and techwriters work closely together without being a bottleneck? You may be familiar with these issues or looking for a better solution to make the customer and internal (in-house) documentation workflows more efficient. In this article, we recap what we covered in our webinar, and publish the answers to the audience's questions.