Source code access, consistency: some ingredients of Adyen's API program
API The Docs Podcast11 Jan 2022

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

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

Episoder(61)

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

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

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

30 Sep 202231min

Techwriting, DX and DevRel working together at Miro - Part1

Techwriting, DX and DevRel working together at Miro - Part1

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

7 Sep 202234min

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

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

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

6 Jul 202238min

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

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

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

13 Jun 202233min

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

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

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

13 Jun 202238min

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

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

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

3 Jun 202237min

Confidence and Critical Thinking in Techwriting: Part 2

Confidence and Critical Thinking in Techwriting: Part 2

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

2 Sep 202120min

Populært innen Teknologi

lydartikler-fra-aftenposten
romkapsel
teknisk-sett
nasjonal-sikkerhetsmyndighet-nsm
tomprat-med-gunnar-tjomlid
shifter
teknologi-og-mennesker
rss-impressions-2
smart-forklart
energi-og-klima
elektropodden
rss-alt-som-gar-pa-strom
fornybaren
rss-heis
rss-ai-forklart
pedagogisk-intelligens
rss-polypod
rss-djtommy43
rss-ki-praten
rss-grenser-for-ki