Building Better Developer Portals: From Design to Support

06/11/2024 39 min Episodio 17
Building Better Developer Portals: From Design to Support

Listen "Building Better Developer Portals: From Design to Support"

Episode Synopsis

In this insightful episode of Build What's Next: Digital Product Perspectives, API expert Jeff Nibler and Michael Gray, Head of Engineering at Method, share their extensive experience with developer portals and API platforms. The discussion covers the transformation of developer portals over the past 5-7 years and crucial elements for success.Key points discussed include:The importance of discoverability and user experience in developer portalsDifferent approaches for internal versus external developer portalsThe evolution from viewing APIs as utilities to seeing them as productsBuilding effective support structures for API programsThe role of sandbox environments and documentation in developer successKey insights shared:Focus on Developer Experience:The importance of clear, human-readable documentationMaking APIs discoverable and easily accessibleProviding interactive consoles and sandbox environmentsInternal vs External Portals:Internal portals focus on avoiding API duplicationExternal portals require additional polish and marketing elementsDifferent support structures are needed for each typeSupport Structures:The need for specialized API support teamsFinding the right balance between developer expertise and support efficiencyIntegration of support ticketing within the portalDocumentation Best Practices:Making content accessible to both technical and non-technical audiencesUsing a CMS for efficient content managementImplementing effective tagging and search capabilitiesThe episode concludes with practical advice for organizations starting their developer portal journey, emphasizing the importance of fundamentals like solid API design, security considerations, and developer experience.Episode Resources:Best practices for API documentationDeveloper portal platforms and toolsAPI design guidelinesSupport team structuresContent management systems for developer portalsEpisode Highlights:[05:48] Discussion of developer portal evolution[17:25] Sandbox environments and developer experience[24:53] Internal portal considerations[29:31] Support team structures[34:14] Starting a developer portal journeyKey Quotes:"The golden rule for me on this topic has always been as much DIY as absolutely possible, everywhere possible.""The struggling moment that causes them to create a space. Because if they don't ask a question, there's no space in their brain for them to see your product.""I want my API people talking to your API people, and that's great, but I don't want them talking to my API developers because they're busy."

More episodes of the podcast Build What’s Next: Digital Product Perspectives