Intentional Jargon and Technical Documentation – Interview with Erin McKean

API The Docs Podcast

Player FM - Internet Radio Done Right

اضافه شده در four سال پیش

محتوای ارائه شده توسط API The Docs. تمام محتوای پادکست شامل قسمت‌ها، گرافیک‌ها و توضیحات پادکست مستقیماً توسط API The Docs یا شریک پلتفرم پادکست آن‌ها آپلود و ارائه می‌شوند. اگر فکر می‌کنید شخصی بدون اجازه شما از اثر دارای حق نسخه‌برداری شما استفاده می‌کند، می‌توانید روندی که در اینجا شرح داده شده است را دنبال کنید.https://fa.player.fm/legal

Tinfoil Swans

1
Matthew Lillard and the Glorious Dorito Salad 43:18

23 روز پیش43:18

پخش در آینده

لیست ها

پسندیدن

دوست داشته شد

43:18

You have a favorite Matthew Lillard film or TV performance. It might be SLC Punk , the Scream franchise, Scooby Doo , Hackers , She's All That , Twin Peaks: The Return , or the new Stephen King and Mike Flanagan movie The Life of Chuck . He's been working in Hollywood for over 30 years, and has a reputation for being kind to fans. But connecting with people is exactly why he got into acting as a kid — the community that comes from putting on a play together and hashing it all out at the diner afterward. It's what drew him to Dungeons & Dragons, and then a spirits company celebrating fantasy and horror fandoms. Lillard joined Tinfoil Swans to talk about growing up not fitting in, the thrill of finding your people, the punk rock high school movie he directed, his wedding cheese wheel, and so much more. For more info visit: foodandwine.com/tinfoilswans Learn more about your ad choices. Visit podcastchoices.com/adchoices…

۵ سال پیش 37:23

MP3•خانه قسمت

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)

57 قسمت

#Tech #API The Docs

API The Docs Podcast

Intentional Jargon and Technical Documentation – Interview with Erin McKean

API The Docs Podcast

published ۵ سال پیش

اشتراک گذاری

MP3•خانه قسمت

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)

57 قسمت

#Tech #API The Docs

همه قسمت ها

API The Docs Podcast

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

۹ روز پیش56: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.…

API The Docs Podcast

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

49 weeks پیش43: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.…

API The Docs Podcast

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

50 weeks پیش50: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!…

API The Docs Podcast

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

52 weeks پیش56: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!…

API The Docs Podcast

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

1 year پیش27: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.

API The Docs Podcast

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

1 year پیش25: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.…

API The Docs Podcast

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

1 year پیش23: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.…

API The Docs Podcast

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

1 year پیش44: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.

API The Docs Podcast

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

1 year پیش49: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.

API The Docs Podcast

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

1 year پیش36: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.…

API The Docs Podcast

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

1 year پیش16: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…

API The Docs Podcast

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

1 year پیش22: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…

API The Docs Podcast

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

1 year پیش28: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…

API The Docs Podcast

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

1 year پیش18: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…

API The Docs Podcast

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

1 year پیش36: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/…

API The Docs Podcast

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

1 year پیش49: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.…

API The Docs Podcast

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

1 year پیش27: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?…

API The Docs Podcast

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

۲ years پیش53: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.…

API The Docs Podcast

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

۲ years پیش42: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.

API The Docs Podcast

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

۲ years پیش23: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.…

API The Docs Podcast

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

۲ years پیش41: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.…

API The Docs Podcast

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

۲ years پیش23: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.…

API The Docs Podcast

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

۲ years پیش50: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…

API The Docs Podcast

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

۲ years پیش42: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…

API The Docs Podcast

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

۲ years پیش41: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/…

API The Docs Podcast

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

۲ years پیش27: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.…

API The Docs Podcast

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

۲ years پیش56: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.…

API The Docs Podcast

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

۳ years پیش30: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.…

API The Docs Podcast

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

۳ years پیش31: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.…

API The Docs Podcast

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

۳ years پیش34: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.…

به Player FM خوش آمدید!

Player FM در سراسر وب را برای یافتن پادکست های با کیفیت اسکن می کند تا همین الان لذت ببرید. این بهترین برنامه ی پادکست است که در اندروید، آیفون و وب کار می کند. ثبت نام کنید تا اشتراک های شما در بین دستگاه های مختلف همگام سازی شود.