Intentional Jargon and Technical Documentation – Interview with Erin McKean

API The Docs Podcast

22:08

Host Francesca Amiker sits down with directors Joe and Anthony Russo, producer Angela Russo-Otstot, stars Millie Bobby Brown and Chris Pratt, and more to uncover how family was the key to building the emotional core of The Electric State . From the Russos’ own experiences growing up in a large Italian family to the film’s central relationship between Michelle and her robot brother Kid Cosmo, family relationships both on and off of the set were the key to bringing The Electric State to life. Listen to more from Netflix Podcasts . State Secrets: Inside the Making of The Electric State is produced by Netflix and Treefort Media.…

hace 4 años 37:23

MP3•Episodio en casa

The Good Docs Project aims to create open source documentation templates, and most recently an information architecture template too. Erin McKean, one of the central orchestrators behind the Good Docs Project, is our guest for this episode. We talk with Erin about why it is so important to intentionally include jargon in your technical documentation and where to do that. She shares her practice on curating a project documentation wishlist to keep the future focus going, and why and how to get documentation treated as a key core feature of a product.

The hosts are Laura Vass (Editor of Developer Portal Newsletter, Co-Founder, Pronovix) and Anett Pozsár (Senior Technical Writer, Pronovix).

Music: Virgill - Its over now (CC)

56 episodios

#Tech #API The Docs

Intentional Jargon and Technical Documentation – Interview with Erin McKean

API The Docs Podcast

published hace 4 años

MP3•Episodio en casa

The hosts are Laura Vass (Editor of Developer Portal Newsletter, Co-Founder, Pronovix) and Anett Pozsár (Senior Technical Writer, Pronovix).

Music: Virgill - Its over now (CC)

56 episodios

#Tech #API The Docs

Todos los episodios

1
Documentation by humans for humans - Discussion with Polina Zaichkina and Max Clayton Clowes 43:21

hace 37 weeks43:21

43:21

How do you get people on board when you shift to a new tool or a new approach? Even if the value proposition is clear, it might be a challenge to create a practice out of the change. In this episode of API The Docs, Polina Zaichkina (Senior technical writer at Codat) and Max Clayton Cowes (Product director for experience at Codat) share insights about building a culture of participation around documentation and achieving internal enablement.…

1
From Inconsistent to Award-winning Docs - Conversation with Naomi Pentrel & Andrew Feierabend 50:38

hace 39 weeks50:38

50:38

In this episode, Naomi Pentrel and Andrew Feierabend share their journey of revamping Viam’s robotics APIs documentation. They discuss the benefits of sitting down with actual users in well-structured interview sessions with specific scripts and tasks. Learn about their approach to user research, their team’s collaborative methodology for achieving daily usability wins, mentoring, and implementing larger-scale changes like automation. And it all started with a smart cat feeder!…

1
The Secret Sauce of Developer Programs: A Conversation with Byrne Reese 56:46

hace 40 weeks56:46

56:46

Byrne Reese had the opportunity to build a number of developer programs over the years. In this episode, he explains his unique Developer Pyramid framework which he uses as a guide to build a successful and scalable developer program now at RingCentral. He also dives into his passion for board games and how it influences his approach to documentation, and explores the Workflow Builder tool that redefines building on the RingCentral platform. Tune in for all the details!…

1
Teaching and Learning Git - Discussion with Anna Skoulikari 27:30

hace 49 weeks27:30

27:30

When it comes to learning Git, it can be daunting to navigate the plethora of learning resources out there. Recognising the need for a visually engaging all-levels experience, Anna Skoulikari (JetBrains) decided to write her own self-study book to help learners along the way.

1
Install ways to check on the overall health of the portal - Conversation with Rachel Lee Nabors 25:39

hace 52 weeks25:39

25:39

"Key results are the things you're going to do to move that number. Here's the thing where most people spin out. There should be a break mechanism on the things that you're doing […] a culture of experimentation, and objective critique around 'Is this the right thing to be doing?” Welcome back to our two parts episode with Rachel Lee Nabors, we continue with talking about developer portal stakeholders and your metrics based approach.…

1
React.dev and storyboarding with Rachel Lee Nabors 23:37

hace 52 weeks23:37

23:37

"You can always tell when it's a novice writer or a writer and an artist who are in bad relation because there will be blocks of text everywhere explaining how the character is feeling […] There's a delicate balance to be struck and it's the same with code.” Welcome Rachel Lee Nabors, one of the creators behind the grand award-winning react.dev portal where all 600+ code examples are manipulable, and in each section’s "code challenges," learners are encouraged to fix broken examples by following clues left by the core team.…

1
On the management track - conversation with Claire Waters 44:35

hace 1 year44:35

44:35

Drawing from her role as a wayfinder, Claire Waters (Senior Manager – Product Content Experience, Cloudflare) shares her team’s using the COIN methodology for embracing AI tools as a team, and how they engage in low-stakes AI challenges to foster familiarity and comfort with AI technologies.

1
The zen of resilience - Discussion with Dan Grabski 49:23

hace 1 year49:23

49:23

You need docs and headspace when a well-oiled system inevitably throws a flat tire. With Dan Grabski we talked from car racing through tech execs mediating at Burning Man, forest fire incident management systems and early expectations setting all the way to API docs and back again.

1
Writing with humans in mind - Discussion with Ryan Young 36:02

hace 1 year36:02

36:02

Technical writers walk a tricky tightrope between delivering accurate technical information and making it comprehensible for a wide range of users with varying levels of technical experience. In this episode, Ryan Young (Technical writer at Stripe) shares his thoughts on bridging the gap between different content layers and writing for humans in a digital world.…

1
DevPortal Awards Jury Interview - Special Edition Part 4 16:34

hace 1 year16:34

16:34

How can one make their devportal accessible and useful at the same time? What can devportal owners do to support inclusive design? We were honored to ask Susanna Laurin (Certified Professional in Accessibility Core Competencies, G3ict and IAAP Representative to the EU) about these questions in 2023’s DevPortal Awards framework. As she highlighted, developer portals were a new field for her, and she saw many angles to approach accessibility. We are happy to share Susanna’s remarks and suggestions with you.Further resources: Best Developer Portals 2023 DevPortal Awards 2023 Jury Interview…

1
DevPortal Awards Jury Interview - Special Edition Part 3 22:10

hace 1 year22:10

22:10

The API The Docs Podcast brings you a Special Edition series with insights from the 2023 DevPortal Awards. Each year, the DevPortal Awards seeks the most outstanding solutions with the help of experienced jurors, who are volunteers with extensive knowledge of API programs, developer portals, and API documentation. In the Special Edition series, we share interviews with the jurors which were recorded during the online Awards Gala events in November, 2023. How can developer portals incorporate gamification into their workflows? How do jurors Anne Gentle (Developer Relations Leader at Cisco DevNet), Bob Watson (Senior Technical Writer), and Michael Richardson (Advanced Software Engineering Manager at Kroger) see the importance of user experience research and design? In 2023, the DevPortal Awards jury members discussed the possibilities, and their remarks could help to create a better user experience for devportals. We are glad to share the episode with you. Further resources: Best Developer Portals 2023 DevPortal Awards 2023 Jury Interview…

1
DevPortal Awards Jury Interview - Special Edition Part 2 28:09

hace 1 year28:09

28:09

The API The Docs Podcast brings you a Special Edition series with insights from the 2023 DevPortal Awards. Each year, the DevPortal Awards seeks the most outstanding solutions with the help of experienced jurors, who are volunteers with extensive knowledge of API programs, developer portals, and API documentation. In the Special Edition series, we share interviews with the jurors which were recorded during the online Awards Gala events in November, 2023. What could be the similarities between Choose Your Own Adventure games and developer portals? Is it possible to reach that level of interactivity to interlocking journeys? In 2023, the DevPortal Awards jury members discussed a few possibilities that could be more than sci-fi. We are happy to share the interviews with you. In this episode, you hear insights from Kruno Golubić (Technical Writer at Memgraph), Marco Spinello (Senior Technical Writer at sanity.io), Richard Smedley (Principal Technical Writer at Couchbase), and Ryan Clifford (Platform Group Product Manager at Spendesk). Further resources: Best Developer Portals 2023 DevPortal Awards 2023 Jury Interview…

1
DevPortal Awards Jury Interview - Special Edition Part 1 18:40

hace 1 year18:40

18:40

The API The Docs Podcast brings you a Special Edition series with insights from the 2023 DevPortal Awards. Each year, the DevPortal Awards seeks the most outstanding solutions with the help of experienced jurors, who are volunteers with extensive knowledge of API programs, developer portals, and API documentation. In the Special Edition series, we share interviews with the jurors which were recorded during the online Awards Gala events in November, 2023. If everything would be possible, what could be the future of developer portals? What aspects do experts welcome, and what elements would be better to leave behind? In 2023, the DevPortal Awards jury members shared their insights with us. We are honored to bring the interviews to you. In this episode, you can learn from DevPortal Awards jurors Chris Bush (Lead Developer Educator at MongoDB), Fabrizio Ferri-Benedetti (Principal Technical Writer at Splunk), and Koichi Shiroma (Senior Product Development). Further resources: Best Developer Portals 2023 DevPortal Awards 2023 Jury Interview…

1
Harnessing the power of customer success - Discussion with Charlie Edwards 36:32

hace 1 year36:32

36:32

Connected to both customers and internal teams, customer success is a powerful source of valuable information throughout the entire feedback loop. In this episode, Charlie Edwards (Customer Success Manager at CAE Technologies Limited) explains how the feedback from customer success teams contributes to the comprehensive improvement of products. The API The Docs Podcast was brought to you by Pronovix. https://pronovix.com/…

1
Building empathy with a beginner’s mindset - Discussion with Adrienne Braganza Tacke 49:46

hace 1 year49:46