One-day conference about API documentation and developer portals

API the Docs is a free event for tech writers, API developers, product owners and developer evangelists who embrace documentation as a crucial aspect of a great developer experience. We believe the conference is a great opportunity to share and discuss the latest best practices, strategies and new trends relevant to API documentation.

Our last API the Docs event we organized in Amsterdam in collaboration with ABN AMRO was a fastlane for learning, thank you everyone! We aim to hold three similar events this year, the first one in Paris in collaboration with Mozilla.

We are thrilled to announce that this edition has a new feature! Renowned members of the documentation community confirmed to form a Speaker Selection Committee. Paris is a test run, and if it is successful, we would like to continue this initiative!

Read our Code of Conduct

Travel information

SNCF workers started rolling rail strikes in March and they continue their walkouts until June on pre-set dates. On April 23 and 24 this industrial unrest affects TER regional, Intercité and high-speed TGV rail services mainly, but there will be disruption on Eurostar and RER lines as well - RER B runs between Paris city centre and CDG airport Paris. Here are some sites where you can get up-to-date information about rail services on strike days: CDG airport Paris, SNCF schedule. Rail services publish information on Twitter too. Follow @SNCF and @RERB.

As a solidarity with SNCF workers, Air France staff announced strike days for April too. April 23 and 24 are affected. Air France offers free re-booking of tickets purchased before April 5. If you have a ticket for April 23, we strongly recommend to re-book it for an other day!

Having a rail services strike in France does not affect public transport in Paris. Once you are there, there should be no problem with moving around in the city! We sincerely hope you will not be discouraged from attending the conference! Please plan your travel in advance and check your itinerary before you start your journey!

Speakers

Ken Davies photo
Big things come in small packages: API information in release notes
Mehdi Medjaoui photo
The state of Banking APIs portals in the PSD2 forced innovation
Bridget Khursheed photo
Security considerations for API docs
Eva Casado de Amezua photo
Starting from scratch: we have APIs, now what?
Anthony Sansone photo
Deploying OpenAPI within an Existing API
Stella Crowhurst photo
How we reduced complexity in our dev experience
Adeel Ali photo
Supercharge API Portals by Speaking Your Devs Language!
Taylor Barnett photo
Going to Infinity and Beyond Documentation with OpenAPI
Karen Sawrey photo
The Bad, the Ugly, and the Good.
Kathleen De Roo photo
Architecting Developer eXperience: What docs does a developer portal need?
Lukas Rosenstock photo
To SDK or not to SDK?

Organizers

Mozilla logo
Pronovix logo
in collaboration with the Paris API meetup group

Agenda

09:00-09:30 / Arrival & Registration
Onsite registration is mandatory. Please do not forget to show up at the Registration Desk. Thank you!
09:30-09:50 / Welcome
Welcome by Jeremie Patonnier (Mozilla) and Kristof Van Tomme (Pronovix)
09:50-10:20 / Mehdi Medjaoui - The state of Banking APIs portals in the PSD2 forced innovation context
EU Banks are obliged to open APIs under the PSD2 regulation. This talk gives the Banking API portal practice state of art and how these institutions do it in this context of forced innovation. Good (and bad) examples are based from “Banking APIs Industry report : Strategy and Tactics for 2018”
10:20-10:50 / Kathleen De Roo - Architecting Developer eXperience: What docs does a developer portal need?
How can you help developers to meet their needs when visiting a developer portal? How can you improve Developer eXperience via documentation types? What developer marketing practices help to reduce API friction?
10:50-11:00 / Coffee break
Drink a coffee and have a bite, courtesy of Apigee.
11:00-11:30 / Eva Casado de Amezua - Starting from scratch: we have APIs, now what?
In a year’s time Typeform evolved from a legacy API and a single Help Center article to launching a Developer Platform and its documentation. This talk is about their learnings building a developer experience from scratch and how they are shaping it to be an strategic asset for the company.
11:30-12:00 / Stella Crowhurst - How we reduced complexity in our dev experience by combining multiple properties in a single portal
Last year my team started a project to make it easier for developers to find the correct API on Worldpay’s developer portal. As a global business, grown through mergers and acquisitions, this was not a trivial problem. This talk is about how we tackled these problems and built some innovative tools and references and contribute to reinforce Worldpay’s reputation of progressive payments provider.
12:00-12:10 / Coffee break
Drink a coffee and have a bite, courtesy of Apigee.
12:10-12:25 / Karen Sawrey - The Bad, the Ugly, and the Good. Moving from GitHub Wiki to a Dedicated Documentation Server
A practical retrospective on moving the existing mass of GitHub-hosted documentation for open source cryptographic products to the company’s own documentation server. Things and tools I wish I knew and had before I started. A few insights on the rarely discussed topic of refactoring the docs.
12:25-12:40 / Adeel Ali - Supercharge API Portals by Speaking Your Devs Language!
Nelson Mandela once said: “If you talk to a man in a language he understands, that goes to his head. If you talk to him in his language, that goes to his heart .”  Developers are no different! Help them use your API in their favorite language and get their love back in the form of beautiful applications.
12:40-14:00 / Lunch break
Please visit nearby restaurants in small groups to continue the conversation over lunch.
14:00-14:30 / Lukas Rosenstock - To SDK or not to SDK?
So, you have an API! Should you leave it at this or also offer a client library/SDK? Using examples from other API providers, this talk will help you decide. We‘ll look at good practices for designing and documenting APIs as well as SDKs, to achieve good developer experience, no matter which choice!
14:30-15:00 / Bridget Khursheed - Security considerations for API docs
When APIs make documentation synonymous with the product, are there security considerations that need to be accounted for? In a PSD2 world where cybersecurity is key what vulnerabilities might documents expose to an attacker? This talk explores how you can maximise security in API documentation.
15:00-15:10 / Coffee break
Drink a coffee and have a bite, courtesy of Apigee.
15:10-15:40 / Ken Davies - Big things come in small packages: API information in release notes
Many companies operate on the SAAS model of regular releases. Once signed up, business and technical clients want to know what’s changed in the platform, particularly the APIs, to make informed decisions. I talk about the challenges of describing APIs in release notes and how these can be overcame.
15:40-16:10 / Taylor Barnett - Going to Infinity and Beyond Documentation with OpenAPI
The OpenAPI Specification provides many overlooked benefits that can assist API providers and documentation writers beyond API documentation. This talk will discuss the more hidden benefits that you can gain from using the OpenAPI Specification and explore the ways you can leverage them.
16:10-16:20 / Coffee break
Drink a coffee and have a bite, courtesy of Apigee.
16:20-16:50 / Anthony Sansone - Deploying OpenAPI within an Existing API
Moving your API spec to a standard sounds great until you sweat the details. API spec automation tools look easy, but their docs read like you have to start from a blank slate. What happens if you have 175 API endpoints? Let’s learn from MongoDB’s experience in planning a foolproof path to Open API.
16:50-17:30 / Unconference session
In this session we would like to give space to peer-to-peer learning, collaboration and discussion. If you have a topic to share, please let us know!
17:30-17:40 / Wrap up & thank you
Closing by Jeremie Patonnier (Mozilla) and Kristof Van Tomme (Pronovix).

Venue

16 Boulevard Montmartre 75009 Paris France

Sponsors

Mozilla logo
Pronovix logo