Start / API The Docs Podcast / Developer friendly api documentation with milecia mcgregor

Developer-friendly API Documentation with Milecia McGregor

34 min • 7 oktober 2020

“When you’re working on APIs that developers use, they need to know exactly how to use them. Great documentation is the way to do this & it gives development a chance to make things more user-friendly.” In this podcast, Milecia McGregor (Developer Advocate, Conducto) reviews why API docs are important and she also shares some tips about how to manage their development cycle.

Senaste avsnitt

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

14 juli | 28 min

How AI Impacts Technical Writing Workflows - Discussion with Anila Zaidi and Marco Spinello

16 juni | 56 min

Documentation by humans for humans - Discussion with Polina Zaichkina and Max Clayton Clowes

18 juli 2024 | 43 min

From Inconsistent to Award-winning Docs - Conversation with Naomi Pentrel & Andrew Feierabend

8 juli 2024 | 51 min

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

27 juni 2024 | 57 min

Teaching and Learning Git - Discussion with Anna Skoulikari

29 april 2024 | 28 min

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

9 april 2024 | 26 min

Building empathy with a beginner’s mindset - Discussion with Adrienne Braganza Tacke

18 januari 2024 | 50 min

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

17 januari 2024 | 27 min

Demystifying DevRel and Tech Writing - Discussion with Kruno Golubic and Katarina Šupe

27 november 2023 | 54 min

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

25 oktober 2023 | 43 min

Empowered community through user-centered design - Discussion with Anthony Pichardo

25 augusti 2023 | 24 min

Unified documentation hubs versus documentation islands - Discussion with Christoph Weber and Kristof Van Tomme

11 juli 2023 | 41 min

Why convert from markdown to confluence? - Interview with Paula Cristina Vaz

30 juni 2023 | 24 min

Innersource and the meaning of collaboration - Interview with Daniel Izquierdo and Kristof Van Tomme

7 juni 2023 | 50 min

The valuable problem: about Domain Driven Design with Luca Vettor

3 maj 2023 | 43 min

A love letter to technical writing - Passo Uno, Fabrizio Ferri-Benedetti

12 april 2023 | 42 min

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

2 mars 2023 | 27 min

Advocacy at Spotify for Developers - Interview with Serah Njambi Kiburu and Alvaro Navarro

14 februari 2023 | 56 min

Typical patterns in the process of API learning – Interview with Emese Hallgató

25 oktober 2022 | 30 min

Techwriting, DX and DevRel working together at Miro - Part 2

30 september 2022 | 32 min

Techwriting, DX and DevRel working together at Miro - Part1

7 september 2022 | 35 min

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

6 juli 2022 | 38 min

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

13 juni 2022 | 34 min

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

13 juni 2022 | 38 min

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

3 juni 2022 | 38 min

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

11 januari 2022 | 33 min

Confidence and Critical Thinking in Techwriting: Part 2

2 september 2021 | 20 min

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

18 augusti 2021 | 32 min

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

15 juli 2021 | 29 min

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

3 juni 2021 | 35 min

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

19 maj 2021 | 32 min

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

29 april 2021 | 33 min

Creating a fully self-service API program - Interview with Alvaro Navarro and Anthony Roux

7 april 2021 | 36 min

Tech writing for software engineers - Interview with Barry Rosenberg

24 mars 2021 | 36 min

Inclusion and Accessibility - some suggestions from fellow documentarians - Interview with Ilona Koren-Deutsch

12 mars 2021 | 35 min

Where Product Marketing Meets the Docs – Interview with Liz Couto

4 december 2020 | 38 min

Feedback Management & Documentation Workflows - Interview with Uwana Ikaiddi

4 november 2020 | 33 min

Intentional Jargon and Technical Documentation – Interview with Erin McKean

2 november 2020 | 37 min

DocOps and Automation to the Delight of Technical Writers! - Interview with Paula Henk & Patrick Hammond (Adyen)

22 oktober 2020 | 33 min

Remote Onboarding and Technical Writing: Things We Can Do Better

14 oktober 2020 | 34 min

Developer-friendly API Documentation with Milecia McGregor

7 oktober 2020 | 34 min

The Evolution of a Documentation Platform - Interview with Fabian Rodriguez (Vonage)

1 oktober 2020 | 36 min

Insider's advice on actions your tech writers can take to create quality API documentation

3 juli 2020 | 21 min

Dev-first API products, API explorers & Microservices

19 juni 2020 | 21 min

Dev Doc Trends w/ Tom Johnson

8 juni 2020 | 11 min

Change management on large & complex documentation sets

21 maj 2020 | 14 min

Defining Top API Use Cases and How to Meet the Goals of Your API's Audience

13 maj 2020 | 17 min

Minimal Viable API Documentation and Developer Experience

30 april 2020 | 21 min

Developer-friendly API Documentation with Milecia McGregor

Senaste avsnitt

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

How AI Impacts Technical Writing Workflows - Discussion with Anila Zaidi and Marco Spinello

Documentation by humans for humans - Discussion with Polina Zaichkina and Max Clayton Clowes

From Inconsistent to Award-winning Docs - Conversation with Naomi Pentrel & Andrew Feierabend

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

Teaching and Learning Git - Discussion with Anna Skoulikari

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

React.dev and storyboarding with Rachel Lee Nabors

On the management track - conversation with Claire Waters

The zen of resilience - Discussion with Dan Grabski

Writing with humans in mind - Discussion with Ryan Young

DevPortal Awards Jury Interview - Special Edition Part 4

DevPortal Awards Jury Interview - Special Edition Part 3

DevPortal Awards Jury Interview - Special Edition Part 2

DevPortal Awards Jury Interview - Special Edition Part 1

Harnessing the power of customer success - Discussion with Charlie Edwards

Building empathy with a beginner’s mindset - Discussion with Adrienne Braganza Tacke

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

Demystifying DevRel and Tech Writing - Discussion with Kruno Golubic and Katarina Šupe

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

Empowered community through user-centered design - Discussion with Anthony Pichardo

Unified documentation hubs versus documentation islands - Discussion with Christoph Weber and Kristof Van Tomme

Why convert from markdown to confluence? - Interview with Paula Cristina Vaz

Innersource and the meaning of collaboration - Interview with Daniel Izquierdo and Kristof Van Tomme

The valuable problem: about Domain Driven Design with Luca Vettor

A love letter to technical writing - Passo Uno, Fabrizio Ferri-Benedetti

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

Advocacy at Spotify for Developers - Interview with Serah Njambi Kiburu and Alvaro Navarro

Typical patterns in the process of API learning – Interview with Emese Hallgató

Techwriting, DX and DevRel working together at Miro - Part 2

Techwriting, DX and DevRel working together at Miro - Part1

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

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

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

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

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

Confidence and Critical Thinking in Techwriting: Part 2

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

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

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

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

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

Creating a fully self-service API program - Interview with Alvaro Navarro and Anthony Roux

Tech writing for software engineers - Interview with Barry Rosenberg

Inclusion and Accessibility - some suggestions from fellow documentarians - Interview with Ilona Koren-Deutsch

Where Product Marketing Meets the Docs – Interview with Liz Couto

Feedback Management & Documentation Workflows - Interview with Uwana Ikaiddi

Intentional Jargon and Technical Documentation – Interview with Erin McKean

DocOps and Automation to the Delight of Technical Writers! - Interview with Paula Henk & Patrick Hammond (Adyen)

Remote Onboarding and Technical Writing: Things We Can Do Better

Developer-friendly API Documentation with Milecia McGregor

The Evolution of a Documentation Platform - Interview with Fabian Rodriguez (Vonage)

Insider's advice on actions your tech writers can take to create quality API documentation

Dev-first API products, API explorers & Microservices

Dev Doc Trends w/ Tom Johnson

Change management on large & complex documentation sets

Defining Top API Use Cases and How to Meet the Goals of Your API's Audience

Minimal Viable API Documentation and Developer Experience