Intentional Jargon And Technical Documentation – Interview With Erin McKean API The Docs podcast

API The Docs Podcast

API The Docs Podcast podcast artwork

Tech API The Docs

Player FM - Internet Radio Done Right

הוסף לפני four שנים

תוכן מסופק על ידי API The Docs. כל תוכן הפודקאסטים כולל פרקים, גרפיקה ותיאורי פודקאסטים מועלים ומסופקים ישירות על ידי API The Docs או שותף פלטפורמת הפודקאסט שלהם. אם אתה מאמין שמישהו משתמש ביצירה שלך המוגנת בזכויות יוצרים ללא רשותך, אתה יכול לעקוב אחר התהליך המתואר כאן https://he.player.fm/legal.

<

<div class="span index">1</div> <span><a class="" data-remote="true" data-type="html" href="/series/before-the-chorus">Before The Chorus</a></span>

<div class="span index">1</div> <span><a class="" data-remote="true" data-type="html" href="/series/before-the-chorus">Before The Chorus</a></span> podcast artwork

<div class="span index">1</div> <span><a class="" data-remote="true" data-type="html" href="/series/before-the-chorus">Before The Chorus</a></span> podcast artwork

1
Before The Chorus

בטל רישום

לפני 9 ימיםלפני 9d ago

בטל רישום

חודשי+

Before a song is released, a record is produced, or a chorus is written, the musicians that write them think. A lot. They live. A lot. And they feel. A LOT. Hosted by award-winning interviewer and radio host Sofia Loporcaro, Before the Chorus dives into the stories and experiences that shape these artists, and ultimately, the music we hear.

API The Docs Podcast « »
Intentional Jargon and Technical Documentation – Interview with Erin McKean

לפני 5 שנים 37:23

שתפו

MP3•בית הפרקים

תוכן מסופק על ידי API The Docs. כל תוכן הפודקאסטים כולל פרקים, גרפיקה ותיאורי פודקאסטים מועלים ומסופקים ישירות על ידי API The Docs או שותף פלטפורמת הפודקאסט שלהם. אם אתה מאמין שמישהו משתמש ביצירה שלך המוגנת בזכויות יוצרים ללא רשותך, אתה יכול לעקוב אחר התהליך המתואר כאן https://he.player.fm/legal.

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)

… continue reading

58 פרקים

#Tech #API The Docs

API The Docs Podcast

API The Docs Podcast podcast artwork

Intentional Jargon and Technical Documentation – Interview with Erin McKean

API The Docs Podcast

published לפני 5 שנים

שתפו

MP3•בית הפרקים

תוכן מסופק על ידי API The Docs. כל תוכן הפודקאסטים כולל פרקים, גרפיקה ותיאורי פודקאסטים מועלים ומסופקים ישירות על ידי API The Docs או שותף פלטפורמת הפודקאסט שלהם. אם אתה מאמין שמישהו משתמש ביצירה שלך המוגנת בזכויות יוצרים ללא רשותך, אתה יכול לעקוב אחר התהליך המתואר כאן https://he.player.fm/legal.

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)

… continue reading

58 פרקים

#Tech #API The Docs

כל הפרקים

×

A

API The Docs Podcast

API The Docs Podcast podcast artwork

1
State of the Docs 2025: Insights from GitBook - Discussion with Addison Schultz 28:28

לפני 16 ימים28:28

הפעל מאוחר יותר

הפעל מאוחר יותר

28:28

We discuss findings from GitBook's "State of the Docs" report (2025), for example that 90% view documentation as crucial for purchases, yet 40% of those interviewed don't track its performance. We talk of speeding up API integration, and GitBook's focus on refining adaptive and personalized documentation features, then address avoiding tunnel vision and keeping discoverability for users, underscoring the ongoing innovation in the field. Bio: Addison Schultz is a web developer & designer working and living in Tokyo, Japan. He leads the developer relations team at GitBook, a tool for technical teams to document their products and APIs. He's been working the last 7 years on collaborative tooling, worked with some of the world’s leading design and development companies, providing product teams with advice and industry advice on how teams can build better products, faster. References: https://www.stateofdocs.com/2025/ https://gitbook.com/docs/ https://apithedocs.org/ai-docs-online-2025…

A

API The Docs Podcast

API The Docs Podcast podcast artwork

1
How AI Impacts Technical Writing Workflows - Discussion with Anila Zaidi and Marco Spinello 56:07

לפני 6 weeks56:07

הפעל מאוחר יותר

הפעל מאוחר יותר

56:07

Welcome back to the A(P)I The Docs podcast! We’re opening this new chapter with an absolute treat of an episode in which Anila Zaidi, Staff Technical Writer at Squarespace, and Marco Spinello, Senior Technical Writer at Booking.com discuss the transformative role of generative AI in technical writing and beyond. We explore how AI has evolved from an experimental tool to an essential aid whilst also touching on the challenges and ethical considerations surrounding AI.…

A

API The Docs Podcast

API The Docs Podcast podcast artwork

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

לפני 1 year43: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.…

A

API The Docs Podcast

API The Docs Podcast podcast artwork

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

לפני 1 year50: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!…

A

API The Docs Podcast

API The Docs Podcast podcast artwork

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

לפני 1 year56: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!…

A

API The Docs Podcast

API The Docs Podcast podcast artwork

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

לפני 1 year27: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.

A

API The Docs Podcast

API The Docs Podcast podcast artwork

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

לפני 1 year25: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.…

A

API The Docs Podcast

API The Docs Podcast podcast artwork

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

לפני 1 year23: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.…

A

API The Docs Podcast

API The Docs Podcast podcast artwork

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

לפני 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.

A

API The Docs Podcast

API The Docs Podcast podcast artwork

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

לפני 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.

A

API The Docs Podcast

API The Docs Podcast podcast artwork

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

לפני 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.…

A

API The Docs Podcast

API The Docs Podcast podcast artwork

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

לפני 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…

A

API The Docs Podcast

API The Docs Podcast podcast artwork

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

לפני 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…

A

API The Docs Podcast

API The Docs Podcast podcast artwork

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

לפני 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…

A

API The Docs Podcast

API The Docs Podcast podcast artwork

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

לפני 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…

A

API The Docs Podcast

API The Docs Podcast podcast artwork

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

לפני 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/…

A

API The Docs Podcast

API The Docs Podcast podcast artwork

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

לפני 2 years49:46

הפעל מאוחר יותר

הפעל מאוחר יותר

49:46

Adopting a beginner’s mindset allows you to explore familiar concepts through a lens of curiosity and openness. But how does that translate to documentation? In this episode, Adrienne Braganza Tacke (Sr. Developer Advocate & DevNet Community Programs Lead at Cisco) explains the unexpected benefits of writing with newcomers in mind and how it can take documentation to the next level.…

A

API The Docs Podcast

API The Docs Podcast podcast artwork

1
Docs anthropology, and how to make content useful for the future - conversation with Portia Burton 27:22

לפני 2 years27:22

הפעל מאוחר יותר

הפעל מאוחר יותר

27:22

How does a biological anthropologist become a professional docs auditor? Portia Burton, founder of DocumentWrite, narrates her meandering journey from biological anthropology to ESL China, through blockchain technology community engineering, all the way to content audit services. We talk about what to look for in an audit, and what is often critical for a successful content inventory [spoiler: speed]. Where to dive in to make the most of the existing content for the future?…

A

API The Docs Podcast

API The Docs Podcast podcast artwork

1
Demystifying DevRel and Tech Writing - Discussion with Kruno Golubic and Katarina Šupe 53:52

לפני 2 years53:52

הפעל מאוחר יותר

הפעל מאוחר יותר

53:52

Technical writing and developer relations are relatively new areas, and they have both grown out of a need for these specific skill sets. However, for newcomers in the IT landscape, it might take a while to understand what they actually mean and how they support the work of developers. Kruno Golubic (technical writer at Memgraph) and Katarina Šupe (DevRel at Memgraph) explain the benefits of a successful mentorship initiative, the different definitions of developer experience, and the challenges of technical writing that set it apart from other disciplines.…

A

API The Docs Podcast

API The Docs Podcast podcast artwork

1
Fostering an API-first culture in a startup environment - Discussion with Alex Akimov and Helen Kosova 42:54

לפני 2 years42:54

הפעל מאוחר יותר

הפעל מאוחר יותר

42:54

From rapid changes to learning on the fly, startups face unique challenges that require creative solutions. Alex Akimov (Head of API Platform at Monite) and Helen Kosova (API Technical Writer at Monite) discuss how Monite’s API council supports the adoption of an API-first approach at the company.

A

API The Docs Podcast

API The Docs Podcast podcast artwork

1
Empowered community through user-centered design - Discussion with Anthony Pichardo 23:51

לפני 2 years23:51

הפעל מאוחר יותר

הפעל מאוחר יותר

23:51

With Anthony Pichardo, product manager at Visa Developer Platform, on the value of user-centered design and building non-zero sum environments where everyone wins. Community is not just an afterthought, it’s an integral part of strategy. The platform team conducts regular user research to gauge pain points, and constantly strives to minimize the learning curve to better serve the community’s needs.…

A

API The Docs Podcast

API The Docs Podcast podcast artwork

1
Unified documentation hubs versus documentation islands - Discussion with Christoph Weber and Kristof Van Tomme 41:00

לפני 2 years41:00

הפעל מאוחר יותר

הפעל מאוחר יותר

41:00

We explore how developer documentation hubs enable a unified information architecture, at least outwards: our guests Christoph Weber (Pronovix) and Kristof Van Tomme (Pronovix) talk about the nuanced, socio-technical nature of large scale documentation processes, the need for a central API docs team, and the future use of private LLMs.…

A

API The Docs Podcast

API The Docs Podcast podcast artwork

1
Why convert from markdown to confluence? - Interview with Paula Cristina Vaz 23:46

לפני 2 years23:46

הפעל מאוחר יותר

הפעל מאוחר יותר

23:46

Developers are the ones who know their APIs best, but they need an easy documentation process that wouldn’t be too different from the coding lifecycle to produce the technical documentation at scale. Senior technical writer Paula Cristina Vaz outlines the Documentation Framework at Farfetch, created to process markdown files and convert them to Confluence HTML. She talks about the page and document templates that help writers structure their documentation in a standardized way.…

A

API The Docs Podcast

API The Docs Podcast podcast artwork

1
Innersource and the meaning of collaboration - Interview with Daniel Izquierdo and Kristof Van Tomme 50:09

לפני 2 years50:09

הפעל מאוחר יותר

הפעל מאוחר יותר

50:09

Daniel Izquierdo (Bitergia) and Kristof Van Tomme (Pronovix) explained their journey with innersource and open-source communities. They also discussed what a company can do with documentation islands (or silos), and what are the role of technical writers in this process. What is the connection between innersource and documentation? How can we define true collaboration? Resources: Innersourcecommons.org API The Docs Virtual 2023: Feedback, Metrics, Analytics series – Recaps Complexity podcast with Jabe Bloom ( Part1 , Part2 ) Developer Portals Newsletter…

A

API The Docs Podcast

API The Docs Podcast podcast artwork

1
The valuable problem: about Domain Driven Design with Luca Vettor 42:43

לפני 2 years42:43

הפעל מאוחר יותר

הפעל מאוחר יותר

42:43

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…

A

API The Docs Podcast

API The Docs Podcast podcast artwork

1
A love letter to technical writing - Passo Uno, Fabrizio Ferri-Benedetti 41:34

לפני 2 years41:34

הפעל מאוחר יותר

הפעל מאוחר יותר

41:34

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/…

A

API The Docs Podcast

API The Docs Podcast podcast artwork

1
Docs-as-Code for better collaboration at Amadeus for Developers - Interview with Anna Tsolakou and Mathieu Pincovai 27:11

לפני 2 years27:11

הפעל מאוחר יותר

הפעל מאוחר יותר

27:11

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.…

A

API The Docs Podcast

API The Docs Podcast podcast artwork

1
Advocacy at Spotify for Developers - Interview with Serah Njambi Kiburu and Alvaro Navarro 56:06

לפני 2 years56:06

הפעל מאוחר יותר

הפעל מאוחר יותר

56:06

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.…

A

API The Docs Podcast

API The Docs Podcast podcast artwork

1
Typical patterns in the process of API learning – Interview with Emese Hallgató 30:09

לפני 3 years30:09

הפעל מאוחר יותר

הפעל מאוחר יותר

30:09

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.…

A

API The Docs Podcast

API The Docs Podcast podcast artwork

1
Techwriting, DX and DevRel working together at Miro - Part 2 31:37

לפני 3 years31:37

הפעל מאוחר יותר

הפעל מאוחר יותר

31:37

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.…

A

API The Docs Podcast

API The Docs Podcast podcast artwork

1
Techwriting, DX and DevRel working together at Miro - Part1 34:51

לפני 3 years34:51

הפעל מאוחר יותר

הפעל מאוחר יותר

34:51

With our three Mironeer guests, DevRel Lead Anthony Roux and Senior Techwriters Mira Balani and Marco Spinello, we talked about how they joined their teams, what they learnt since, how and by whom their developer docs came to be as they are today, and what two documentarians are to do if they disagree.…

A

API The Docs Podcast

API The Docs Podcast podcast artwork

1
Interview with Anthony Sansone, staff technical writer at MongoDB - The importance of onboarding in techwriting 38:28

לפני 3 years38:28

הפעל מאוחר יותר

הפעל מאוחר יותר

38:28

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.…

A

API The Docs Podcast

API The Docs Podcast podcast artwork

1
Interview with Marc Burgauer part 2 - Will social practices eat your change strategy for breakfast? 33:36

לפני 3 years33:36

הפעל מאוחר יותר

הפעל מאוחר יותר

33:36

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 minimum shared vocabulary and methods to change anything for the better in a persistent, self-stabilizing socio-technical system–our workplace–and do we need to name practice theory at all for it?…

A

API The Docs Podcast

API The Docs Podcast podcast artwork

1
Interview with Marc Burgauer part 1 - Will social practices eat your change strategy for breakfast? 38:29

לפני 3 years38:29

הפעל מאוחר יותר

הפעל מאוחר יותר

38:29

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 minimum shared vocabulary and methods to change anything for the better in a persistent, self-stabilizing socio-technical system–our workplace–and do we need to name practice theory at all for it?…

A

API The Docs Podcast

API The Docs Podcast podcast artwork

1
When is no news good news for a scheduling platform? - Interview with DevRel Kristyn Bryan and Application Architect Dmitry Pashkevich from Calendly 37:32

לפני 3 years37:32

הפעל מאוחר יותר

הפעל מאוחר יותר

37:32

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?…

A

API The Docs Podcast

API The Docs Podcast podcast artwork

1
Source code access, consistency: some ingredients of Adyen's API program 33:17

לפני 4 years33:17

הפעל מאוחר יותר

הפעל מאוחר יותר

33:17

Interview with Ruby Batallones, Technical Writer at Adyen and Aleksei Akimov, Head of API at Adyen Involve your technical writers already from the API design discussions: this can help ensure a consistent user experience across all APIs, and in finding the middle ground between the usability requirements and the architecture requirements. At Adyen, technical writers have the ways and means to add and maintain the descriptions in the source code, they can make sure that all the bits and pieces are linked together and enough context is provided everywhere. This practice brought that techwriters habitually use the developer tools as well, and have a deeper technical understanding of the API, which in turn enables better communications earlier on. The recently open sourced Adyen Explorer and documentation won 2 prizes at the 2019 DevPortal Awards: Best API Reference Documentation and Best Decision Maker Documentation. Our guests are Ruby Batallones Technical Writer at Adyen, former solution architect and implementation engineer, and Aleksei Akimov, who started his career in software development, then added technical writing, was leading the Documentation & Developer Experience team and is now responsible for Adyen API design, strategy, and governance. The hosts are Laura Vass (Editor of Developer Portals Newsletter, Co-Founder of Pronovix) and Anett Pozsár (Senior Technical Writer, Pronovix).…

A

API The Docs Podcast

API The Docs Podcast podcast artwork

1
Confidence and Critical Thinking in Techwriting: Part 2 20:14

לפני 4 years20:14

הפעל מאוחר יותר

הפעל מאוחר יותר

20:14

MongoDB is one of the most popular NoSQL database programs, providing both on-premise and cloud-based solutions. Tony works as a senior technical writer on cloud based tools. He has 20+ years experience in computer hardware, software, and services, specializing in data protection and user security, and he is a long-time supporter of API The Docs. In this second part of the interview we continue our conversation: - Adoption of OpenAPI specification - How to save large amounts of documentation time? - How to keep the specifications up-to-date? - How to simplify API documentation? The hosts are Laura Vass (Editor of Developer Portals Newsletter, Co-Founder of Pronovix) and Anett Pozsár (Senior Technical Writer, Pronovix).…

A

API The Docs Podcast

API The Docs Podcast podcast artwork

1
Confidence and Critical Thinking part 1: techwriting is life-long learning - Interview with Anthony Sansone, Senior Technical Writer at MongoDB 32:16

לפני 4 years32:16

הפעל מאוחר יותר

הפעל מאוחר יותר

32:16

Confidence and Critical Thinking: techwriting is life-long learning - Interview with Anthony Sansone, Senior Technical Writer at MongoDB MongoDB is one of the most popular NoSQL database programs, providing both on-premise and cloud-based solutions. Tony works as a senior technical writer on cloud based tools. He has 20+ years experience in computer hardware, software, and services, specializing in data protection and user security, and he is a long-time supporter of API The Docs. In this interview, Tony and the hosts are delving into the following topics: How has the technical writing job market changed lately? Speeding up complex onboarding and training of new technical writers at MongoDB Embrace inquisitive juniors and help build confidence, keep open office hours In Part 2, Episode 22, we continue our conversation: Adoption of OpenAPI specification How to save large amounts of documentation time? How to keep the specifications up-to-date? How to simplify API documentation? The hosts are Laura Vass (Editor of Developer Portals Newsletter, Co-Founder of Pronovix) and Anett Pozsár (Senior Technical Writer, Pronovix).…

A

API The Docs Podcast

API The Docs Podcast podcast artwork

1
Building a DevRel Team - Interview with Lorna Mitchell, Head of Developer Relations at Aiven. 29:19

לפני 4 years29:19

הפעל מאוחר יותר

הפעל מאוחר יותר

29:19

Building a DevRel Team - Interview with Lorna Mitchell, Head of Developer Relations at Aiven. Lorna is an open source software developer and project maintainer, published author, blogger and conference speaker, who is with us today to talk about the skills and roles that contribute to successfully operating a devrel team: Priorities and structure when developing a new devrel team Roles and responsibilities Involving a technical writer in the team Career path, growth and collaboration in a devrel team Insights of creating a new open source devportal Aiven open source data tools and products Maintenance of documentation and workflows Sources: Read more about Lorna’s work here: https://lornajane.net/ For job offerings at Aiven, please visit: https://aiven.io/careers The hosts are Laura Vass (Editor of Developer Portals Newsletter, Co-Founder of Pronovix) and Anett Pozsár (Senior Technical Writer, Pronovix).…

A

API The Docs Podcast

API The Docs Podcast podcast artwork

1
Feedback is the key! - Interview with Alex Hoffer, Developer Relations Engineer at Plaid 35:23

לפני 4 years35:23

הפעל מאוחר יותר

הפעל מאוחר יותר

35:23

Alex Hoffer is a DevRel engineer at Plaid. Previously, she was managing the QA team at Dropbox for 6 years. At Plaid, she's been working on documentation and an overhaul of the Plaid developer docs. Developer experience is extremely important at Plaid and the docs are a big part of that. Tune in to hear more about how to create an excellent developer experience: How does a cross-functional team work together with other departments in order to improve the developer functionality? How developer experience is about product, documentation and engineering collaborating together? What is her role in the API Review Committee, which helps ensure APIs are standardized and maintain their API style guide? Docs revamp - how have they approached it, why have they done it, where is it going next? How does the entire doc editing and authorship process work at Plaid? And last but not least, how have they incorporated user feedback into the docs process! The host is Laura Vass (Editor of Developer Portals Newsletter, Co-Founder of Pronovix). Sources: https://plaid.com/blog/new-plaid-docs/ plaid.com/careers…

A

API The Docs Podcast

API The Docs Podcast podcast artwork

1
Getting into the tech industry through technical writing - Interview with Carolyn Stransky, Frontend Engineer at Bryter 31:48

לפני 4 years31:48

הפעל מאוחר יותר

הפעל מאוחר יותר

31:48

Former technical writer, previously a journalist and now fronted engineer, conference speaker and workshop organizer. Tune in to learn about Carolyn's career journey. How did she transition from journalism to technical writing and how did her previously acquired journalism skills support that journey? Why and how did she become a software engineer? What was her role in the Google Season of Docs program that connects experienced technical writers with the open source community? What does humanizing your documentation mean in practice? How to write a good FAQ page to best support the onboarding process? In this episode we are exploring a new topic that hasn't been touched on yet over the API The Docs podcast series. The host is Anett Pozsár (Senior Technical Writer, Pronovix). Sources: https://workwithcarolyn.com/ Google - Season of Docs…

A

API The Docs Podcast

API The Docs Podcast podcast artwork

1
A good design is not about how something looks, it's about how something works - Interview with Liam Gallagher and Jake Eastham from Barclays 32:45

לפני 4 years32:45

הפעל מאוחר יותר

הפעל מאוחר יותר

32:45

Today our guests are Liam Gallagher (UX Designer/API Platforms) and Jake Eastham (Front-end Developer and Accessibility Champion) from Barclays: “It's very easy to get caught up in aesthetics, you want to design something that is really cool and you think it is amazing.. You actually want to show it to everyone, but you completely messed up the accessibility part. As I matured, I realised that good design is not about something that looks good, but how something works. A good design is naturally inclusive. “ “An accessibility champion is someone who fosters within their environment, within their own team, while being aware of the different accessibility challenges you have and why we are designing and developing our products, what is the importance of it. “ Join us for an inspiring conversation with the two times winner of DevPortal Awards in the Best Accessible Portal category. The hosts are Laura Vass (Editor of Developer Portals Newsletter, Co-Founder of Pronovix) and Anett Pozsár (Senior Technical Writer, Pronovix).…

A

API The Docs Podcast

API The Docs Podcast podcast artwork

1
Creating a fully self-service API program - Interview with Alvaro Navarro and Anthony Roux 35:38

לפני 4 years35:38

הפעל מאוחר יותר

הפעל מאוחר יותר

35:38

Meet the Developer Relations & API product management team on Amadeus for Developers - Open API Product for the travel industry. Our guests are Alvaro Navarro and Anthony Roux. “Building trusted relationships is actually what matters in our job.. and empathy is what makes the big difference. Put yourself into the shoes of the other person, that's how you're going to learn how they use your product. And that's how you're going to be successful.“ How has Amadeus innovated a framework and a new set of self-service APIs, where developers can connect in a matter of only three minutes? How have they scaled up and automated all the processes to make the onboarding as smooth as possible? Why is testing and user centric feedback, API Governance and product management support important when creating solutions that provide the best developer experience for your API consumers? Tune in to hear more. The hosts are Laura Vass (Editor of Developer Portals Newsletter, Co-Founder of Pronovix) and Anett Pozsár (Senior Technical Writer, Pronovix).…

A

API The Docs Podcast

API The Docs Podcast podcast artwork

1
Tech writing for software engineers - Interview with Barry Rosenberg 35:54

לפני 4 years35:54

הפעל מאוחר יותר

הפעל מאוחר יותר

35:54

Our guest is Barry Rosenberg, technical writer at Google and co-author of courses Technical Writing One and Technical Writing Two. At the beginning of his professional journey, Barry was starting out as a teacher for a smaller group of undergraduate students at MIT. How did he become a teacher of a highly scalable class for thousands of engineers at Google? How has writing fiction helped him to write better technical courses? Join us to learn more about his inspiring career and the courses he created: How and why have these courses been developed? Why is it valuable to teach tech writing to engineers? What are the prerequisites and skills required to become an efficient technical writer? What new tech writing courses are currently being created at Google? The hosts are Laura Vass (Editor of Developer Portals Newsletter, Co-Founder of Pronovix) and Anett Pozsár (Senior Technical Writer, Pronovix). Sources: Barry Rosenbeeg - Spring Into Technical Writing for Engineers and Scientists Overview of technical writing courses at Google…

A

API The Docs Podcast

API The Docs Podcast podcast artwork

1
Inclusion and Accessibility - some suggestions from fellow documentarians - Interview with Ilona Koren-Deutsch 34:39

לפני 4 years34:39

הפעל מאוחר יותר

הפעל מאוחר יותר

34:39

We ask Ilona Koren-Deutsch about the Women in APIs initiative, and her advice on how to diversify a team. We talk about considerations to ensure accessibility for your content, and what can propel the company-wide use of a conscious inclusive style guide. Where should you be channel agnostic as a techwriter? Does feedback need feedback? Tune in to find out, where to get mentoring and support, how to take an active role in empowering other women in the industry, and how to create equal opportunities, regardless of gender, language barriers or other impairment issues. The hosts are Laura Vass (Editor of the Developer Portals Newsletter, Co-Founder of Pronovix) and Ádám Balogh (Technical Writer at Pronovix). Sources: Women in APIs…

ברוכים הבאים אל Player FM!

Player FM סורק את האינטרנט עבור פודקאסטים באיכות גבוהה בשבילכם כדי שתהנו מהם כרגע. זה יישום הפודקאסט הטוב ביותר והוא עובד על אנדרואיד, iPhone ואינטרנט. הירשמו לסנכרון מנויים במכשירים שונים.

תקשיבו ל-500+ נושאים

מדריך עזר מהיר

פודקאסטים מובילים

מכביבול ברדיו תל אביב

הזווית - פודקאסט

בכל יום נתון - אוריאל דסקל וראם שרמן

עושים חשבון Osim Heshbon

טייכר וזרחוביץ' ברדיו תל אביב

טייכר וזרחוביץ' - מערכונים

גיבור תרבות Culture Hero

סרטים זה אנחנו - מגזין קולנוע

עושים תוכנה Osim Tochna

השבוע - פודקאסט הארץ

המשחק הגדול

חושבים טוב

המעבדה The Lab

מדע בגובה האוזניים

סליחה על השאלה - ההסכת You Can't Ask That Podcast

סיפור ישראלי

עבר פלילי

Lets Talk Murder | בואי נדבר רצח

Lets Talk Murder | בואי נדבר רצח

האזן לתוכנית הזו בזמן שאתה חוקר