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.

Read our Code of conduct

Speakers

Ben Hall photo
The Art of Documentation and Readme.md
Jessica Parsons photo
The Best of Both Worlds: A Git-Based CMS for Static Sites
Daniele Procida
What nobody tells you about documentation
Rosalie Marshall photo
Creating consistent API documentation in government
Jaroslav Machan photo
Opening a door to a sleeping Castle
Jennifer Riggins photo
How can API documentation become inherently agile?
Andrew Johnston logo
Documenting GraphQL at Shopify
Daniel D Beck photo
410 Gone: documenting API deprecations and shutdowns

Organizers

Pronovix logo
GDS logo
Write The Docs London logo
in collaboration with the Write the Docs London meetup group

Agenda

08:30-09:00 / Registration
Onsite registration is mandatory. Please visit the registration desk. Thanks!
09:00-09:30 / Welcome
Opening speech by Kristof Van Tomme
09:30-10:00 / Jessica Parsons – The Best of Both Worlds: A Git-Based CMS for Static Sites
Static site generators and Git-based workflows bring API documentation closer to code in a way that encourages developer participation, but can also present barriers for non-developers who want to focus on writing. Netlify CMS is an open-source project that helps bridge this gap.
10:10-10:40 / Jaroslaw Machaň – Opening a door to a sleeping Castle
When you’re the oldest&biggest bank in the Country with so complicated IT infrastructure that one rather runs way when sees it, it’s quite challenging to design a great DX portal for your newly borned API ecosystem.But it’s a great opportunity to show your community that nothing is impossible.
10:50-11:20 / Rosalie Marshall - Creating consistent API documentation in government
11:20-11:30 / Break
Grab a coffee in the hall.
11:30-12:30 / Unconference sessions
Potential topics: Static sites, Enterprise portals, Role based access control, API sandboxes, API specification formats, Federated search systems
12:30-14:00 / Lunch break
Please visit nearby restaurants in small groups to continue conversation over lunch.
14:00-14:30 / Daniel D. Beck – 410 Gone: documenting API deprecations and shutdowns
When your API is shut down, it’s a stressful situation for both you and your users. In this talk, you’ll learn how to capably handle such an event, and to avoid a communications disaster when it’s time to break the bad news.
14:40-15:10 / Jennifer Riggins – How can API documentation become inherently agile?
15:20-15:50 / Daniele Procida – The four kinds of documentation, and why you need to understand what they are
Software teams, libraries, projects rarely thrive unless supported by adequate documentation. Most developers know that. So they try to write it - and most of the time they write the wrong things in the wrong places in the wrong way. That’s because four different kinds of documentation are required.
15:50-16:10 / Break
Grab a coffee in the hall.
16:10-16:40 / Andrew Johnston – Documenting GraphQL at Shopify
Shopify has announced the Storefront API, a GraphQL based API. This talk covers our custom tooling, approach to descriptions / conceptual material, and the relationship of our GraphQL docs to the existing developer hub and REST API.
16:50-17:20 / Ben Hall – The Art of Documentation and Readme.md
The goal of the talk is to help open source contributors understand how small changes to their documentation approach can have an enormous impact on how users get started.
17:30-18:00 / Wrap up & thank you
Closing by Kristof Van Tomme

Venue

The Trampery Old Street, 239 Old St, London EC1V 9EY, UK

Sponsors

Pronovix logo
Nexmo logo