
API The Docs Podcast
15 FOLLOWERS
Our guests talk about their insights and experience as documentarians. We bring advice from behind open and closed developer portals, ideas on what new learnings you can aim for, and recent experiments from the field of API documentation.
API The Docs Podcast
3w ago
Business and technical personas may have different skills, and in many cases, they use different terminology. Luca Vettor (Information Architect at Deltatre) explained how Domain Driven Design and event storming create transparent communication between the two personas. What is induced and intrinsic complexity? How could we define the problem space when the customer is in a complex environment and their problems are intertwined? Luca Vettor helped us to answer these questions.References:
Luca Vettor’s blog ..read more
API The Docs Podcast
1M ago
Why did Fabrizio Ferri-Benedetti (Senior Staff Technical Writer at Splunk) write a love letter to technical writing? How could technical writers create a bridge between the different parts of a company? With an MSc in cognitive psychology, Fabrizio shares a nuanced perspective in his ‘Docs' hierarchy of priorities’ and associated metrics.References:
A love letter to technical writing
https://isten-ct.com/formacion-comunicacion-tecnica/
https://itcqf.org/
https://passo.uno/docs-hierarchy-of-needs ..read more
API The Docs Podcast
2M ago
Anna Tsolakou (Developer Advocate) and Mathieu Pincovai (Customer Success Specialist) shared with us the journey on how Amadeus for Developers created consistent and clear documentation. We also talked about why the docs-as-code approach is so crucial for them, and how they can create the right documentation for their APIs ..read more
API The Docs Podcast
2M ago
Spotify Senior Developer Advocates Serah Njambi Kiburu and Alvaro Navarro talked with us about the two enemies of developer empathy, and their practices to optimise and scale for the community’s real needs. We also asked why Spotify even needs an API developer portal, and why isn’t it built on backstage? (spoiler alert) They have good reasons for that ..read more
API The Docs Podcast
2M ago
Our guest Emese Hallgató works as a UX researcher at Pronovix Developer Portals. Her education and experience in computer programming and in psychological research open the door to better understanding developers and their needs. How do developers approach coding, and what do they need to reach a state of flow? We talk about the archetypes of systematic, opportunistic, and pragmatic developers.
If you would like to deep-dive into the topic more, read Emese’s ‘How do developers learn about APIs?’ article ..read more
API The Docs Podcast
2M ago
In Part 2 of our conversation with Miro's DevRel Lead Anthony Roux and Senior Techwriters Mira Balani and Marco Spinello, we walk deeper into how their respective teams complement each other, and we will also get a detailed narrative from Anthony about their process to aggregate all types of feedback, whether it's a feature requests, bugs, or documentation improvements into one central base ..read more
API The Docs Podcast
2M ago
Our guest is Anthony Sansone, staff technical writer at MongoDB, who has spent 20+ years in computer hardware, software, and services, specializing in data protection and user security. His experience ranges from startups to large multinational companies. In this episode, Anthony shares his insights about the techwriters’ onboarding and the inspiration you can get from new hires ..read more
API The Docs Podcast
2M ago
Or, maybe you could map it: what does each of you do, why, and how? We converse about integration of practices and practice networks with Marc Burgauer, co-founder of Contextualise. Together with Chris McDermott, they assist large organizations in their transformation efforts through maturity mapping. We are teasing out our ideas on how can the understanding of social practice theory–and the acceptance of complexity–possibly help write better technical documentation. How can we better ease and inform the users of the docs into the context in which the artifact operates? What would be the minim ..read more
API The Docs Podcast
2M ago
Or, maybe you could map it: what does each of you do, why, and how? We converse about integration of practices and practice networks with Marc Burgauer, co-founder of Contextualise. Together with Chris McDermott, they assist large organizations in their transformation efforts through maturity mapping. We are teasing out our ideas on how can the understanding of social practice theory–and the acceptance of complexity–possibly help write better technical documentation. How can we better ease and inform the users of the docs into the context in which the artifact operates? What would be the minim ..read more
API The Docs Podcast
2M ago
We asked DevRel Kristyn Bryan and Application Architect Dmitry Pashkevich from the Calendly API team about the new, v2 of their API and the upgraded devportal. Why and how did they redesign the legacy API? They adopted a design-first approach to building APIs. How does this new strategy manifest in their daily jobs, what are they now doing differently? What are their teams' practices with customer feedback, and with internal mentoring ..read more