Intentional Jargon and Technical Documentation – Interview with Erin McKean

Intentional Jargon and Technical Documentation – Interview with Erin McKean

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)

Avsnitt(61)

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

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

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, pro...

18 Aug 202132min

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

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

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

15 Juli 202129min

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

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

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

3 Juni 202135min

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

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

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

19 Maj 202131min

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

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

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

29 Apr 202132min

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

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

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

7 Apr 202135min

Tech writing for software engineers - Interview with Barry Rosenberg

Tech writing for software engineers - Interview with Barry Rosenberg

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

24 Mars 202135min

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

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

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

12 Mars 202134min

Populärt inom Teknik

uppgang-och-fall
elbilsveckan
bilar-med-sladd
market-makers
skogsforum-podcast
rss-uppgang-och-fall
rss-laddstationen-med-elbilen-i-sverige
rss-elektrikerpodden
har-vi-akt-till-mars-an
gubbar-som-tjotar-om-bilar
rss-veckans-ai
rss-powerboat-sverige-podcast
bli-saker-podden
rss-technokratin
developers-mer-an-bara-kod
hej-bruksbil
rss-en-ai-till-kaffet
natets-morka-sida
rss-snacka-om-ai
rss-fabriken-2