We tend to call it Developer portal, but in reality we have to address many more stakeholders than “just” developers. Especially when your APIs are linked to a complex (although market-leading!) B2B trade insurance product. We give it a try…
Two years ago, Adyen realized the Swagger UI wasn’t meeting their needs... so they decided to build their own. We’ll share how we designed and built our new API Explorer - making it more extendable, and easier for Developers and Technical Writers to maintain. We’ll also talk about our future plans, including open sourcing it for the community.
The talk covers Onfido's journey as a company from developer-led documentation to a full-time holistic focus on Developer Experience— and what that means for us. Some examples are achieving consistency across our API client libraries and moving on from OpenAPI-generated libraries, trialling a documentation-led approach for developing the newest version of the Onfido API, and separating our product and technical documentation without compromising on user experience.
Leveraging API Docs and Tools at Mercedes-Benz /developersPronovix
This talk walks along the developer portal journey, the steps taken to improve DX, challenges the team tackled with from its corporate context and the growth of data products of the platform. A special focus will be placed on API docs and dev tools.
Many of us have heard about Docs As Code. Applying the same tooling and delivery CI/CD (Continuous Integration and Continuous Delivery) pipelines as developers to improve the quality of (API) documentation sounds nifty. We’ll take a look at the philosophy, best practices and how to get started.
Your customers’ success depends not just o running Hello World, but using your API in a complete app to accomplish a business goal. Getting started is definitely important, but it’s just the first step towards the customers’ ultimate goal: getting finished! Let me help you help them finish!
Most of us are not going to change the world. Don’t let that stop you. You can still change the way APIs are created in your community, and reap the benefits of the spec-first design approach. Be the hero your community needs and your APIs deserve.
Imagine a place where a lone technical writer is creating API specs by hand, from scratch, for a bunch of existing APIs. A place where developers don’t know if an API exists at all because there’s no documentation for it. Where product owners design new APIs in a single Excel spreadsheet.
Places like that exist; maybe you’ve experienced something similar first-hand. Perhaps you thought to yourself, “I wish I could turn this place around”. And you can. You’re not “just a technical writer” - your perspective, insight, and skills are crucial for not just documenting, but also designing and developing usable APIs.
In this talk, you will hear some ideas for what technical writers can do to make their job documenting APIs easier and collaboration with stakeholders stronger. We will look at the benefits of the spec-first approach, strategies for implementing it, and challenges you may encounter. A real-world example of building a spec-first API culture within a company will illustrate how long it took, what worked (and what didn’t), and where improvement is still needed.
The goal is to equip technical writers with advice and motivation to start influencing API design decisions in their community. Documentarians represent the voice of the user to a great extent, but this voice is not always heard. Luckily, it’s not too late to change that.
From Zero to Sixty: Driving a DocOps Based Approach to APIs at Ford Motor Com...Pronovix
How does a 115 year old automaker transform into a Mobility company? Platform Enablement! The session take a look under the hood at Ford and will highlight Ford’s ongoing journey into building and cultivating a DocOps and developer centric approach to APIs.
INTERFACE, by apidays - API Design is where culture and tech meet each other...apidays
INTERFACE, by apidays 2021 - It’s APIs all the way down
June 30, July 1 & 2, 2021
API Design is where culture and tech meet each other
Aleksei Akimov, Head of API at Adyen
Two years ago, Adyen realized the Swagger UI wasn’t meeting their needs... so they decided to build their own. We’ll share how we designed and built our new API Explorer - making it more extendable, and easier for Developers and Technical Writers to maintain. We’ll also talk about our future plans, including open sourcing it for the community.
The talk covers Onfido's journey as a company from developer-led documentation to a full-time holistic focus on Developer Experience— and what that means for us. Some examples are achieving consistency across our API client libraries and moving on from OpenAPI-generated libraries, trialling a documentation-led approach for developing the newest version of the Onfido API, and separating our product and technical documentation without compromising on user experience.
Leveraging API Docs and Tools at Mercedes-Benz /developersPronovix
This talk walks along the developer portal journey, the steps taken to improve DX, challenges the team tackled with from its corporate context and the growth of data products of the platform. A special focus will be placed on API docs and dev tools.
Many of us have heard about Docs As Code. Applying the same tooling and delivery CI/CD (Continuous Integration and Continuous Delivery) pipelines as developers to improve the quality of (API) documentation sounds nifty. We’ll take a look at the philosophy, best practices and how to get started.
Your customers’ success depends not just o running Hello World, but using your API in a complete app to accomplish a business goal. Getting started is definitely important, but it’s just the first step towards the customers’ ultimate goal: getting finished! Let me help you help them finish!
Most of us are not going to change the world. Don’t let that stop you. You can still change the way APIs are created in your community, and reap the benefits of the spec-first design approach. Be the hero your community needs and your APIs deserve.
Imagine a place where a lone technical writer is creating API specs by hand, from scratch, for a bunch of existing APIs. A place where developers don’t know if an API exists at all because there’s no documentation for it. Where product owners design new APIs in a single Excel spreadsheet.
Places like that exist; maybe you’ve experienced something similar first-hand. Perhaps you thought to yourself, “I wish I could turn this place around”. And you can. You’re not “just a technical writer” - your perspective, insight, and skills are crucial for not just documenting, but also designing and developing usable APIs.
In this talk, you will hear some ideas for what technical writers can do to make their job documenting APIs easier and collaboration with stakeholders stronger. We will look at the benefits of the spec-first approach, strategies for implementing it, and challenges you may encounter. A real-world example of building a spec-first API culture within a company will illustrate how long it took, what worked (and what didn’t), and where improvement is still needed.
The goal is to equip technical writers with advice and motivation to start influencing API design decisions in their community. Documentarians represent the voice of the user to a great extent, but this voice is not always heard. Luckily, it’s not too late to change that.
From Zero to Sixty: Driving a DocOps Based Approach to APIs at Ford Motor Com...Pronovix
How does a 115 year old automaker transform into a Mobility company? Platform Enablement! The session take a look under the hood at Ford and will highlight Ford’s ongoing journey into building and cultivating a DocOps and developer centric approach to APIs.
INTERFACE, by apidays - API Design is where culture and tech meet each other...apidays
INTERFACE, by apidays 2021 - It’s APIs all the way down
June 30, July 1 & 2, 2021
API Design is where culture and tech meet each other
Aleksei Akimov, Head of API at Adyen
Want some practical ways to benchmark the launch or improvement of your developer portal? As an expert in technical communication, APIs, and developer experience, I’ll share ways to increase your digital presence to engage and compel your audience to keep coming back for more!
Are you convinced that APIs are Products too ? If yes, take the next step and learn how you can embed an API as a Product culture within your organization.
apidays LIVE Paris 2021 - Test developer experience, not code by Kathrine Osa...apidays
apidays LIVE Paris 2021 - APIs and the Future of Software
December 7, 8 & 9, 2021
Test developer experience, not code
Kathrine Osadchenko, API Technical Writer & Content Developer at WIX.com
apidays LIVE Paris 2021 - Building an analytics API by David Wobrock, Botifyapidays
apidays LIVE Paris 2021 - APIs and the Future of Software
December 7, 8 & 9, 2021
Building an analytics API
David Wobrock, Senior Lead API Engineer at Botify
An Inside Look at a Large-scale Writer-driven REST API Doc Solution at Salesf...Pronovix
23 different REST APIs, 26+ teams, 150+ writers — how we built a unified solution. In this session, hear the inside story of how a handful of writers developed a REST API doc solution and earned the trust of executives and engineering teams across Salesforce along the way.
apidays LIVE Australia 2021 - Confessions of a Product Geek : My First API BY...apidays
apidays LIVE Australia 2021 - Accelerating Digital
September 15 & 16, 2021
Confessions of a Product Geek : My First API
Rosemary Missier, Product Manager at Xero
apidays LIVE Paris - How to position the API driven Architecture to support t...apidays
apidays LIVE Paris - Responding to the New Normal with APIs for Business, People and Society
December 8, 9 & 10, 2020
How to position the API driven Architecture to support the digital transformation?
Jarvis Ka, Enterprise Architect at Indiana Farm Bureau Insurance
[WSO2Con EU 2018] APIs - Technology That Can Transform Your Business Into a P...WSO2
This presentation focuses on how an organization would work on a successful API strategy that aligns with their business vision. We will use best practices and case studies from WSO2 deployments as well as public case studies.
apidays LIVE India - The link between technical documentation and developer e...apidays
apidays LIVE India 2021 - Connecting 1.3 billion digital innovators
May 20, 2021
The link between technical documentation and developer engagement
Sneha Sridharan, Technical Writer at Zoho Corporation
apidays LIVE LONDON - Lessons learnt supporting developer communities by Math...apidays
apidays LIVE LONDON - The Road to Embedded Finance, Banking and Insurance with APIs
Lessons learnt supporting developer communities
Mathieu Pincovai, Customer Success Specialist at Amadeus for Developers
The motivation on why and when to use API-First service design. What are the real-life poblems in application development with regard to API's ? And how to solve these using tools like Swagger Editor , Swagger UI and Swagger-codegen. And how can an API Manager tool help to manage the Apllication Lifecycle of your API ( publishing , versioning, registration of consumers , quota's and rate-limiting )
Zohar Babin, Senior Director, Ecosystem and Community, Kaltura
While a great many API enthusiasts will tell you that achieving API utopia means re-architecting all of your applications (Web, mobile, or otherwise) on top of the same APIs that you make available to external developers, very few organizations have actually succeeded at doing what's necessary; turning their infrastructures inside out. Many organizations can't envision having the time, patience, or resources to fly a plane while the wings are being ripped-off and reinstalled. But open source video platform provider Kaltura pulled it off. As a result, Kaltura's core infrastructure -- back end servers, core applications, etc. --- rely on the same APIs that front-facing partners' applications rely on. The result was a highly flexible future-proof platform that enables customers, partners, developers and startups to rapidly extend the platform with innovative implementations that continuously push the limits of what Kaltura can do. In this presentation, Kaltura willl cover the principles of what makes a great, dogfoodable API, how to make it resilient, future-proof and yet backward compatible, and most importantly how to enable and support customers and partners looking to extend an API platform.
apidays LIVE Paris - Level up: Autonomous Integration Mesh by Zdenek Nemecapidays
apidays LIVE Paris - Responding to the New Normal with APIs for Business, People and Society
December 8, 9 & 10, 2020
Level up: Autonomous Integration Mesh
Zdenek Nemec, Founder and CTO at Superface.ai
apidays LIVE Jakarta - What will the next generation of API Portals look like...apidays
apidays LIVE Jakarta 2021 - Accelerating Digitisation
February 24, 2021
What will the next generation of API Portals look like?
Allan Knabe, API Product Manager & Co-founder at apiable.io
Bulletproofing Your APIs: Why Users’ Feedback MattersPronovix
The uncomfortable truth about DX: everyone talks about it, and yet only a few get it right. What about you? We know testing and feedback collection can be hard, but we’re here to tell you that it doesn’t have to be that way: from bug hunting challenges to hackathons, we’ve got a few ideas to share.
apidays LIVE Australia 2021 - Designing Embedded Platforms by Jeremy Glassenb...apidays
apidays LIVE Australia 2021 - Accelerating Digital
September 15 & 16, 2021
Designing Embedded Platforms: Lessons from Industry Success & Failure
Jeremy Glassenberg, Product Lead, APIs at Docusign
apidays LIVE London 2021 - Human-centred API Governance by Arnaud Lauret, Nat...apidays
apidays LIVE London 2021 - Reaching Maximum Potential in Banking & Insurance with API Mindset
October 27 & 28, 2021
APIs in Finance: The Next Evolution
Human-centred API Governance
Arnaud Lauret, Senior API Architect at Natixis & Author of "Design of Web APIs"
apidays LIVE LONDON - Revolut Marketplace & APIs by Stijn Pieperapidays
apidays LIVE LONDON - The Road to Embedded Finance, Banking and Insurance with APIs
Revolut Marketplace & APIs
Stijn Pieper, Lead Product Owner at Revolut
Want some practical ways to benchmark the launch or improvement of your developer portal? As an expert in technical communication, APIs, and developer experience, I’ll share ways to increase your digital presence to engage and compel your audience to keep coming back for more!
Are you convinced that APIs are Products too ? If yes, take the next step and learn how you can embed an API as a Product culture within your organization.
apidays LIVE Paris 2021 - Test developer experience, not code by Kathrine Osa...apidays
apidays LIVE Paris 2021 - APIs and the Future of Software
December 7, 8 & 9, 2021
Test developer experience, not code
Kathrine Osadchenko, API Technical Writer & Content Developer at WIX.com
apidays LIVE Paris 2021 - Building an analytics API by David Wobrock, Botifyapidays
apidays LIVE Paris 2021 - APIs and the Future of Software
December 7, 8 & 9, 2021
Building an analytics API
David Wobrock, Senior Lead API Engineer at Botify
An Inside Look at a Large-scale Writer-driven REST API Doc Solution at Salesf...Pronovix
23 different REST APIs, 26+ teams, 150+ writers — how we built a unified solution. In this session, hear the inside story of how a handful of writers developed a REST API doc solution and earned the trust of executives and engineering teams across Salesforce along the way.
apidays LIVE Australia 2021 - Confessions of a Product Geek : My First API BY...apidays
apidays LIVE Australia 2021 - Accelerating Digital
September 15 & 16, 2021
Confessions of a Product Geek : My First API
Rosemary Missier, Product Manager at Xero
apidays LIVE Paris - How to position the API driven Architecture to support t...apidays
apidays LIVE Paris - Responding to the New Normal with APIs for Business, People and Society
December 8, 9 & 10, 2020
How to position the API driven Architecture to support the digital transformation?
Jarvis Ka, Enterprise Architect at Indiana Farm Bureau Insurance
[WSO2Con EU 2018] APIs - Technology That Can Transform Your Business Into a P...WSO2
This presentation focuses on how an organization would work on a successful API strategy that aligns with their business vision. We will use best practices and case studies from WSO2 deployments as well as public case studies.
apidays LIVE India - The link between technical documentation and developer e...apidays
apidays LIVE India 2021 - Connecting 1.3 billion digital innovators
May 20, 2021
The link between technical documentation and developer engagement
Sneha Sridharan, Technical Writer at Zoho Corporation
apidays LIVE LONDON - Lessons learnt supporting developer communities by Math...apidays
apidays LIVE LONDON - The Road to Embedded Finance, Banking and Insurance with APIs
Lessons learnt supporting developer communities
Mathieu Pincovai, Customer Success Specialist at Amadeus for Developers
The motivation on why and when to use API-First service design. What are the real-life poblems in application development with regard to API's ? And how to solve these using tools like Swagger Editor , Swagger UI and Swagger-codegen. And how can an API Manager tool help to manage the Apllication Lifecycle of your API ( publishing , versioning, registration of consumers , quota's and rate-limiting )
Zohar Babin, Senior Director, Ecosystem and Community, Kaltura
While a great many API enthusiasts will tell you that achieving API utopia means re-architecting all of your applications (Web, mobile, or otherwise) on top of the same APIs that you make available to external developers, very few organizations have actually succeeded at doing what's necessary; turning their infrastructures inside out. Many organizations can't envision having the time, patience, or resources to fly a plane while the wings are being ripped-off and reinstalled. But open source video platform provider Kaltura pulled it off. As a result, Kaltura's core infrastructure -- back end servers, core applications, etc. --- rely on the same APIs that front-facing partners' applications rely on. The result was a highly flexible future-proof platform that enables customers, partners, developers and startups to rapidly extend the platform with innovative implementations that continuously push the limits of what Kaltura can do. In this presentation, Kaltura willl cover the principles of what makes a great, dogfoodable API, how to make it resilient, future-proof and yet backward compatible, and most importantly how to enable and support customers and partners looking to extend an API platform.
apidays LIVE Paris - Level up: Autonomous Integration Mesh by Zdenek Nemecapidays
apidays LIVE Paris - Responding to the New Normal with APIs for Business, People and Society
December 8, 9 & 10, 2020
Level up: Autonomous Integration Mesh
Zdenek Nemec, Founder and CTO at Superface.ai
apidays LIVE Jakarta - What will the next generation of API Portals look like...apidays
apidays LIVE Jakarta 2021 - Accelerating Digitisation
February 24, 2021
What will the next generation of API Portals look like?
Allan Knabe, API Product Manager & Co-founder at apiable.io
Bulletproofing Your APIs: Why Users’ Feedback MattersPronovix
The uncomfortable truth about DX: everyone talks about it, and yet only a few get it right. What about you? We know testing and feedback collection can be hard, but we’re here to tell you that it doesn’t have to be that way: from bug hunting challenges to hackathons, we’ve got a few ideas to share.
apidays LIVE Australia 2021 - Designing Embedded Platforms by Jeremy Glassenb...apidays
apidays LIVE Australia 2021 - Accelerating Digital
September 15 & 16, 2021
Designing Embedded Platforms: Lessons from Industry Success & Failure
Jeremy Glassenberg, Product Lead, APIs at Docusign
apidays LIVE London 2021 - Human-centred API Governance by Arnaud Lauret, Nat...apidays
apidays LIVE London 2021 - Reaching Maximum Potential in Banking & Insurance with API Mindset
October 27 & 28, 2021
APIs in Finance: The Next Evolution
Human-centred API Governance
Arnaud Lauret, Senior API Architect at Natixis & Author of "Design of Web APIs"
apidays LIVE LONDON - Revolut Marketplace & APIs by Stijn Pieperapidays
apidays LIVE LONDON - The Road to Embedded Finance, Banking and Insurance with APIs
Revolut Marketplace & APIs
Stijn Pieper, Lead Product Owner at Revolut
Nur durch qualitativ hochwertiges und zielgerichtetes API Management können lebendige API-Ökosysteme geschaffen werden. Diese API-Ökosysteme bieten Unternehmen die Chance ihre IT-Assets optimal an interne und externe Stakeholder anzubinden. Dadurch bietet sich ein hohes Potenzial, Unternehmen können sowohl bestehende IT-Systeme optimieren als auch komplett neue Geschäftsideen und Partnerschaften umsetzen. Doch was bedeutet qualitativ hochwertiges und zielgerichtetes API Management? Und wie kann man die Integration in bestehende, stark regulierte IT Landschaften schaffen und dabei Mehrwert für interne Beteiligten als auch externe Partner generieren? Wir stellen unseren Ansatz und Erfahrungen mit der SaaS Plattform und API Marketplace 'Syncier Marketplace' vor und gehen auf die Herausforderungen in der Versicherungsbranche ein.
apidays LIVE Australia 2020 - API Value Chain by Christian Raquelapidays
apidays LIVE Australia 2020 - Building Business Ecosystems
API Value Chain - Identifying and developing business assets that deliver the most value
Christian Raquel, Director - Engineering at Industrie & Co
The OLB Group is a FinTech company offering a suite of product
solutions in the merchant services and payment facilitator verticals,
including a cloud-based omni-channel commerce platform for SMBs,
electronic payment processing, and crowd funding services for
issuers and broker/dealers.
Best of NOAH 16 London Startups - Presentation by Brian Smillie, Founder & CEO and Roger Gosine, Co-Founder of Beezer at the NOAH Conference Berlin 2017, Tempodrom on the 23rd of June 2017.
Observability with Elastic at Audi Business InnovationElasticsearch
In the automotive world, time to market and innovation are critical. This includes digital solutions driven by software teams. Audi Business Innovation (ABI), a subsidiary of AUDI AG, uses Elastic to provide observability as a service to all developers within the VW-Group, helping them rapidly bring digital solutions to market. Learn how Elasticsearch Service helps them focus on delivering value to their customers, while saving time and costs.
ADFILE is a cloud based workflow management system created for time-based businesses to track jobs from lead generation through to invoicing, reducing paperwork and giving back valuable time.
Open APIs - Open Banking - Digital Transformation WSO2
Technology continues to be a driving force behind the progression and innovation of the financial services sector. The UK’s Open Banking initiative, coupled with recent legislative changes, will give customers greater clarity, control and ownership of their data, opening the sector to further innovation.
This session was presented by Seshika Fernando, Head of Financial Solutions at WSO2 at Tech UK's event on Open Banking, PSD2 and the Cyber Challenges Facing the Financial Services Sector
Adeptical Solutions is a leading IT consultancy, offshore product development, architecture optimization, and website design & development firm based out of India. Our rich domain expertise keeps us going and providing better value to our clients.
Adeptical Solutions is a leading IT consultancy, offshore product development, architecture optimization, and website design & development firm based out of India. Our rich domain expertise keeps us going and providing better value to our clients.
What's the right funding option for your Salesforce biz? Watch this webinar and hear directly from investors at Emergence Capital & Lighter Capital.
Learn which funding options best suit each stage of the business growth cycle - from startup through the $10M revenue milestone - and what to consider when evaluating those options for your business.
By the time they're reading the docs, it's already too latePronovix
Your relationship with a developer begins before they even know your product's name. In fact, before they know they need a product like yours.
In this talk, Matthew will make the case that developer marketing, developer experience, and developer education are part of a continuum. And that if you're thinking of documentation as something that happens only after someone has signed-up for your API, then you're leaving it too late. He'll draw on pedagogical and marketing research to propose a model for the developer learning journey where traditional API documentation is just one stop along the way.
Attend this talk and you'll come away with practical ideas for how to start educating developers earlier in their product evaluation and learning journey.
Optimizing Dev Portals with Analytics and FeedbackPronovix
Making informed decisions on which features to prioritize in a developer portal can be a daunting task. In this session, we'll show you how to leverage experiments, data, and user feedback to evaluate their potential and refine your approach. We'll explore how testing ideas with minimal investment, akin to an MVP, can help you avoid building features that don't meet your users' needs.
Success metrics when launching your first developer portalPronovix
Building our a developer portal may seem easy at the onset with off the shelf options, but when you're building a custom portal to match the needs of your company, it's not as easy. In this session, we'll talk about our process in determining the right places to start with success metrics and features through an early stage feedback back before having customers. You'll see our intention is to tell a story with multiple facets for multiple people, developers, product managers, C suite decision makers etc... Stories around API usage, health, cost, errors and support to provide our users with an overall of their business performance through our APIs.
AI is entering the world of APIs, where API documentation plays a critical role. One of the fundamental challenges is the need to share understanding about an API and keep the knowledge up to date. AI can potentially speed up API integrations dramatically, but it greatly depends on API documentation.
Let's explore the emerging approach to employing AI in APIs, discuss its impact on API documentation, and see how changing our way of working with APIs will lead to self-integrating applications.
Making sense of analytics for documentation pagesPronovix
As content producers, we invest considerable time and effort in developing, packaging, and delivering content that we think our users need. After publishing the content, we hope that users find our content useful. And we often wonder how users really navigate and consume our content. Web page analytics can help us gauge the information needs of our customers, assess their content consumption behavior, and find opportunities to improve our content and how we deliver it.
Kumar explores the basics of web analytics, pitfalls of relying too much on web analytics for important decisions, the typical web analytics process, and he will share some guidelines for interpreting web analytics numbers.
Feedback cycles and their role in improving overall developer experiencesPronovix
Drawing from experiences from open source work and her time at Spotify, Serah’s talk cover the challenges, opportunities and hacks around proactive and reactive monitoring, processing, tracking and acting on stakeholder and community feedback, and argue for the centricity of well-defined feedback loops in improving the overall developer experiences for any product and features you are responsible for.
GraphQL Isn't An Excuse To Stop Writing DocsPronovix
The main goal of API documentation is to help developers understand how to use an API. With GraphQL, developers often assume it's self-documenting capabilities are sufficient for anyone that consumes their GraphQL API. But did you ever validate this?
Good API documentation offers both static and interactive ways to learn how to consume the API. API's that support GraphQL often only come with interactive documentation, in the shape of a GraphiQL Playground. However, the first time you (or your users) use a GraphQL API can be very frustrating as GraphQL APIs typically only have an interactive playground. it increases the complexity for newcomers to GraphQL as it assumes you’re already familiar with GraphQL. But with GraphQL, you’re not limited to just an interactive playground, as you can create static or interactive documentation next to having this playground. This talk explores which forms of documentation you can use and how they add value to your GraphQL API.
Web3 is one of the fastest-growing spaces on the web right now, with thousands of new projects emerging every week. Each project aims to fill a gap in the space by providing a new technology How do we keep up with documentation, and what should be prioritized for these projects as they scale?
Web3, also referred to as the read-write-own web, is a new form of the internet that utilizes technologies such as blockchain networks, cryptocurrency, crypto wallets, and digital assets like NFTs. The Web3 space is growing by the thousands every week, with new projects and technologies constantly emerging. As writers, it can be challenging to navigate through the space, make sense of every piece of new content, and understand what should be written about for others to read, and what will be irrelevant next week. Many of these new technologies are using pieces of code known as smart contracts or interacting with the APIs of multiple applications at once. What documentation are end-users looking for, and what is the most beneficial format for them to read and comprehend all of this new information? In this talk, I'll discuss what I've learned as a Senior Technical Writer for Filebase, a decentralized cloud storage provider at the heart of hundreds of Web3 projects, and what our customers have benefited from the most when it comes to documentation.
Why your API doesn’t solve my problem: A use case-driven API designPronovix
API docs frequently fail to address developers’ needs by omitting common usage scenarios and use cases. Let’s take a look at good and bad practices for documenting API use cases, and take steps to ensure that developers get from our API and docs what they really want.
You wrote an API specification, documented your endpoints, and published SDKs. Here’s a question, though: Does your API actually solve your users’ problems?
API providers often fail to address common use cases to solve users’ needs, or their assumptions don’t match the reality. This may end up in frustration and loss of users.
In this talk, we will take a peek into developers’ mindset. I will show how to better understand the developers’ needs by researching the usage patterns, existing libraries and 3rd party experience layers, provide examples of good and bad practices, and suggest actionable steps to improve developer experience for your API.
At times, you have to build docs that cover not only REST-y APIs but also frontend SDKs. What do you do, when you have to offer docs for multiple such SDKs, based on different frameworks, under rapid, uncoordinated development with multiple feature enhancements per iteration and at times, with breaking changes, but versioned and searchable?
Developing a best-in-class deprecation policy for your APIsPronovix
Nobody likes ambiguity—especially when it comes to the stability of APIs and the expectations for availability long term. Avoid common pitfalls and explore a critical area where trust is built with developers through thoughtful policy and the development of best-in-class documentation.
A good deprecation policy involves a lot of forward thinking and an awareness of how developers or end users are currently leveraging your capabilities, and how a given API or feature deprecation could affect them in the future. The hard-earned trust that you’ve built and maintained with these individuals is at risk with any type of policy or documentation that is unclear.
The road to developing a clear, trustworthy deprecation policy is a multi-faceted initiative with input from product, engineering, customer success and other cross-functional teams, as well as external market awareness.
Knowing which voices to have in the room, what the industry standards are, and formulating appropriate communication timelines will ensure a world class policy is developed and documented before it’s needed.
Join us as we dive into the nuances of this process and how to avoid the common pitfalls that come from lacking a strategic, thoughtful approach to documenting a deprecation policy for your APIs.
At MongoDB, we now generate REST API references for MongoDB Atlas from annotations in the product’s source. Our team’s writers proposed, planned, led, and implemented this project–and learned a lot along the way. We’ll share how we got buy-in from engineering and product stakeholders, coordinated the project across teams, implemented swagger-core annotations in Java, and drove positive change to benefit our team, the company, and our users.
What do developers do when it comes to understanding and using APIs?Pronovix
It turns out there is no single answer. Developers may have unique goals, motivations, constraints, and challenges, and all of these influence how they approach the problem in front of them. However, more than a decade ago, three development styles were identified - systematic, pragmatic, and opportunistic - and the academic literature suggests that these still exist today.
Two of the three approaches, the systematic and the opportunistic pattern, can be considered as opposite extremes, while the pragmatic approach is situated in between and is similar to both. It is not a personality trait - people may approach a situation one way or another depending on their circumstances, goals, and motivations (however, they may also have a preferred approach, which is usually their characteristic).
Understanding the differences between these patterns (and the different needs) helps us to design in a way that serves most of the users, and even helps them to get into a state of flow by providing the optimal level of challenge to solve their problem.
Inclusive, Accessible Tech: Bias-Free Language in Code and ConfigurationsPronovix
It's time to take the bias out of code, UI, docs, configurations, or our everyday language by ensuring we choose our words carefully to avoid harmful subtext or exclusion. We can do our part and take steps by examining assets from code to config files to API specifications to standards.
Heard of suss? You can suss out more information or you can find someone's information to be suss. "Suss" shows the flexibility of language. It’s an ongoing process to change how we use certain words. It's important to choose words carefully to convey the correct meaning and avoid harmful subtext or exclusion. Let's explore some of the tools and triage methods that it takes from an engineering viewpoint to make bias-free choices. How can you ensure that biased words do not sneak into code, UI, docs, configurations, or our everyday language?
First, let's walk through how to take an inventory of assets from code to config files to API specifications to standards. Next, by placing those findings into categories, prioritize the work to substitute with inclusive alternatives. Let's examine some examples using both API and code assets. Next is a demonstration of how to automate analyzing your source code or documentation with a linter, looking for patterns based on rules that are fed into the tool.
What's in the future for these efforts? Inclusive language should expand beyond English and North America efforts. To do so, let's organize the work with automation tooling, as engineers do.
Creating API documentation for international communitiesPronovix
How to create documentation and write code for an international audience, not just the people who speak and think like you. Make your APIs more useful for everyone on the planet.
Much of the documentation supplied by both Open Source and Close Souce projects assume the community have a good understanding of the English language and often North American culture as well. This creates barriers for many solution providers, who are the gateway to potentially huge markets for your project.
This talk discusses some of the cultural differences, particularly for people from Asia, in using English language API documentation. It suggests some strategies to help diverse audiences understand you APIs and create solutions using them.
The talk will cover not only differences in language but also other cultural differences that are often not obvious. For example:
Different expectations about publication formats, release processes, levels of support during the development process
Meeting and communications styles
Software development workflows, processes, and tools
Supporting people who are visually impaired will also be briefly discussed.
As well as discussing these issues, specific suggestions will be provided to make API docs accessible for as many people as possible.
This talk is based on Alec's work with customers in Europe, North America, Middle East, Asia, and Australasia. The last five have been spent as a developer evangelist working with PaperCut partners in China, Japan, Korea, US and Europe.
APIs in a modern enterprise are rarely uniform or all of the same type. The multitude of API types can be due to organic growth, mergers and acquisitions, or any number of other reasons. Regardless of their origin, APIs of all types need to be fully documented to facilitate a developer’s journey as they interact with your API ecosystem in order to develop useful applications. In this talk I will show examples of how we have augmented developer portals to document APIs that are not of the REST variety, such as AsyncAPI, GraphQL, SOAP, gRPC, and more, such that all API documentation can seamlessly live side-by-side.
Docs-as-Code: Evolving the API Documentation ExperiencePronovix
We are a software engineering team creating API docs. Docs are authored using Instructional Design principles to narrate use-cases and practical API implementations. This talk shares why & how we've applied software development practices to evolve our document tooling, creation, & delivery methods.
Our APIs describe asynchronous protocols used for embedded software (firmware) components in a digital 2-way radio communications system. The API is protocol data unit (PDU) based and its definition is described in a proprietary format; consequently, well-known API formats, such as Swagger/OpenAPI, or tools, such as doxygen, are not used.
Our product training and technical writing teams are very experienced in Instructional Design methods, but these teams have only written documentation for an end-user audience. Understanding software development processes is equally important as understanding two-way radio networks in order to successfully integrate with the APIs. This is the rationale for having a software engineering team develop the skillsets to write API documentation for a developer audience.
With a solid foundation of API documentation in place, regular examination of engineering efficiency and developer experience is appropriate. Repeated actions can be replaced by automation. Content can be modular and re-usable. Formats can be streamlined for easier consumption. Docs can be made portable and lightweight for faster delivery.
Developer journey - make it easy for devs to love your productPronovix
Ever wonder how some products are just lovable and easy to use while other are not? The good products have optimized onboarding into their ecosystem where you get the information served at the right time.
That’s thanks to developer journey and we will teach you how to get it right!
We will go through the basics such as how to analyze existing and non-existing developer touchpoints, set metrics and optimize them to increase the conversion.
Deliberate Complexity Conferences - 19 JULY 2022
Alicia Juarrero - Complexity is not complicatedness
Professor Alicia Juarrero, a leading complexity theory philosopher and academic, as well as the founder and president of VectorAnalytica, a technology company that specializes in large scale scientific data capture and real time analysis tools. Alicia's work in complexity theory is widely quoted by thought leaders in the technology space and referenced in many recent complexity-informed approaches for managing highly dynamic systems, as well as in knowledge management.
How cognitive biases and ranking can foster an ineffective architecture and d...Pronovix
Deliberate Complexity Conferences - Building Successful Platforms and APIs (29 June). Kenny Baas-Schwegler & Evelyn van Kelle - How cognitive biases and ranking can foster an ineffective architecture and design
Maruthi Prithivirajan, Head of ASEAN & IN Solution Architecture, Neo4j
Get an inside look at the latest Neo4j innovations that enable relationship-driven intelligence at scale. Learn more about the newest cloud integrations and product enhancements that make Neo4j an essential choice for developers building apps with interconnected data and generative AI.
Climate Impact of Software Testing at Nordic Testing DaysKari Kakkonen
My slides at Nordic Testing Days 6.6.2024
Climate impact / sustainability of software testing discussed on the talk. ICT and testing must carry their part of global responsibility to help with the climat warming. We can minimize the carbon footprint but we can also have a carbon handprint, a positive impact on the climate. Quality characteristics can be added with sustainability, and then measured continuously. Test environments can be used less, and in smaller scale and on demand. Test techniques can be used in optimizing or minimizing number of tests. Test automation can be used to speed up testing.
Epistemic Interaction - tuning interfaces to provide information for AI supportAlan Dix
Paper presented at SYNERGY workshop at AVI 2024, Genoa, Italy. 3rd June 2024
https://alandix.com/academic/papers/synergy2024-epistemic/
As machine learning integrates deeper into human-computer interactions, the concept of epistemic interaction emerges, aiming to refine these interactions to enhance system adaptability. This approach encourages minor, intentional adjustments in user behaviour to enrich the data available for system learning. This paper introduces epistemic interaction within the context of human-system communication, illustrating how deliberate interaction design can improve system understanding and adaptation. Through concrete examples, we demonstrate the potential of epistemic interaction to significantly advance human-computer interaction by leveraging intuitive human communication strategies to inform system design and functionality, offering a novel pathway for enriching user-system engagements.
DevOps and Testing slides at DASA ConnectKari Kakkonen
My and Rik Marselis slides at 30.5.2024 DASA Connect conference. We discuss about what is testing, then what is agile testing and finally what is Testing in DevOps. Finally we had lovely workshop with the participants trying to find out different ways to think about quality and testing in different parts of the DevOps infinity loop.
UiPath Test Automation using UiPath Test Suite series, part 6DianaGray10
Welcome to UiPath Test Automation using UiPath Test Suite series part 6. In this session, we will cover Test Automation with generative AI and Open AI.
UiPath Test Automation with generative AI and Open AI webinar offers an in-depth exploration of leveraging cutting-edge technologies for test automation within the UiPath platform. Attendees will delve into the integration of generative AI, a test automation solution, with Open AI advanced natural language processing capabilities.
Throughout the session, participants will discover how this synergy empowers testers to automate repetitive tasks, enhance testing accuracy, and expedite the software testing life cycle. Topics covered include the seamless integration process, practical use cases, and the benefits of harnessing AI-driven automation for UiPath testing initiatives. By attending this webinar, testers, and automation professionals can gain valuable insights into harnessing the power of AI to optimize their test automation workflows within the UiPath ecosystem, ultimately driving efficiency and quality in software development processes.
What will you get from this session?
1. Insights into integrating generative AI.
2. Understanding how this integration enhances test automation within the UiPath platform
3. Practical demonstrations
4. Exploration of real-world use cases illustrating the benefits of AI-driven test automation for UiPath
Topics covered:
What is generative AI
Test Automation with generative AI and Open AI.
UiPath integration with generative AI
Speaker:
Deepak Rai, Automation Practice Lead, Boundaryless Group and UiPath MVP
In his public lecture, Christian Timmerer provides insights into the fascinating history of video streaming, starting from its humble beginnings before YouTube to the groundbreaking technologies that now dominate platforms like Netflix and ORF ON. Timmerer also presents provocative contributions of his own that have significantly influenced the industry. He concludes by looking at future challenges and invites the audience to join in a discussion.
Alt. GDG Cloud Southlake #33: Boule & Rebala: Effective AppSec in SDLC using ...James Anderson
Effective Application Security in Software Delivery lifecycle using Deployment Firewall and DBOM
The modern software delivery process (or the CI/CD process) includes many tools, distributed teams, open-source code, and cloud platforms. Constant focus on speed to release software to market, along with the traditional slow and manual security checks has caused gaps in continuous security as an important piece in the software supply chain. Today organizations feel more susceptible to external and internal cyber threats due to the vast attack surface in their applications supply chain and the lack of end-to-end governance and risk management.
The software team must secure its software delivery process to avoid vulnerability and security breaches. This needs to be achieved with existing tool chains and without extensive rework of the delivery processes. This talk will present strategies and techniques for providing visibility into the true risk of the existing vulnerabilities, preventing the introduction of security issues in the software, resolving vulnerabilities in production environments quickly, and capturing the deployment bill of materials (DBOM).
Speakers:
Bob Boule
Robert Boule is a technology enthusiast with PASSION for technology and making things work along with a knack for helping others understand how things work. He comes with around 20 years of solution engineering experience in application security, software continuous delivery, and SaaS platforms. He is known for his dynamic presentations in CI/CD and application security integrated in software delivery lifecycle.
Gopinath Rebala
Gopinath Rebala is the CTO of OpsMx, where he has overall responsibility for the machine learning and data processing architectures for Secure Software Delivery. Gopi also has a strong connection with our customers, leading design and architecture for strategic implementations. Gopi is a frequent speaker and well-known leader in continuous delivery and integrating security into software delivery.
Goodbye Windows 11: Make Way for Nitrux Linux 3.5.0!SOFTTECHHUB
As the digital landscape continually evolves, operating systems play a critical role in shaping user experiences and productivity. The launch of Nitrux Linux 3.5.0 marks a significant milestone, offering a robust alternative to traditional systems such as Windows 11. This article delves into the essence of Nitrux Linux 3.5.0, exploring its unique features, advantages, and how it stands as a compelling choice for both casual users and tech enthusiasts.
Generative AI Deep Dive: Advancing from Proof of Concept to ProductionAggregage
Join Maher Hanafi, VP of Engineering at Betterworks, in this new session where he'll share a practical framework to transform Gen AI prototypes into impactful products! He'll delve into the complexities of data collection and management, model selection and optimization, and ensuring security, scalability, and responsible use.
Enchancing adoption of Open Source Libraries. A case study on Albumentations.AIVladimir Iglovikov, Ph.D.
Presented by Vladimir Iglovikov:
- https://www.linkedin.com/in/iglovikov/
- https://x.com/viglovikov
- https://www.instagram.com/ternaus/
This presentation delves into the journey of Albumentations.ai, a highly successful open-source library for data augmentation.
Created out of a necessity for superior performance in Kaggle competitions, Albumentations has grown to become a widely used tool among data scientists and machine learning practitioners.
This case study covers various aspects, including:
People: The contributors and community that have supported Albumentations.
Metrics: The success indicators such as downloads, daily active users, GitHub stars, and financial contributions.
Challenges: The hurdles in monetizing open-source projects and measuring user engagement.
Development Practices: Best practices for creating, maintaining, and scaling open-source libraries, including code hygiene, CI/CD, and fast iteration.
Community Building: Strategies for making adoption easy, iterating quickly, and fostering a vibrant, engaged community.
Marketing: Both online and offline marketing tactics, focusing on real, impactful interactions and collaborations.
Mental Health: Maintaining balance and not feeling pressured by user demands.
Key insights include the importance of automation, making the adoption process seamless, and leveraging offline interactions for marketing. The presentation also emphasizes the need for continuous small improvements and building a friendly, inclusive community that contributes to the project's growth.
Vladimir Iglovikov brings his extensive experience as a Kaggle Grandmaster, ex-Staff ML Engineer at Lyft, sharing valuable lessons and practical advice for anyone looking to enhance the adoption of their open-source projects.
Explore more about Albumentations and join the community at:
GitHub: https://github.com/albumentations-team/albumentations
Website: https://albumentations.ai/
LinkedIn: https://www.linkedin.com/company/100504475
Twitter: https://x.com/albumentations
A tale of scale & speed: How the US Navy is enabling software delivery from l...sonjaschweigert1
Rapid and secure feature delivery is a goal across every application team and every branch of the DoD. The Navy’s DevSecOps platform, Party Barge, has achieved:
- Reduction in onboarding time from 5 weeks to 1 day
- Improved developer experience and productivity through actionable findings and reduction of false positives
- Maintenance of superior security standards and inherent policy enforcement with Authorization to Operate (ATO)
Development teams can ship efficiently and ensure applications are cyber ready for Navy Authorizing Officials (AOs). In this webinar, Sigma Defense and Anchore will give attendees a look behind the scenes and demo secure pipeline automation and security artifacts that speed up application ATO and time to production.
We will cover:
- How to remove silos in DevSecOps
- How to build efficient development pipeline roles and component templates
- How to deliver security artifacts that matter for ATO’s (SBOMs, vulnerability reports, and policy evidence)
- How to streamline operations with automated policy checks on container images
zkStudyClub - Reef: Fast Succinct Non-Interactive Zero-Knowledge Regex ProofsAlex Pruden
This paper presents Reef, a system for generating publicly verifiable succinct non-interactive zero-knowledge proofs that a committed document matches or does not match a regular expression. We describe applications such as proving the strength of passwords, the provenance of email despite redactions, the validity of oblivious DNS queries, and the existence of mutations in DNA. Reef supports the Perl Compatible Regular Expression syntax, including wildcards, alternation, ranges, capture groups, Kleene star, negations, and lookarounds. Reef introduces a new type of automata, Skipping Alternating Finite Automata (SAFA), that skips irrelevant parts of a document when producing proofs without undermining soundness, and instantiates SAFA with a lookup argument. Our experimental evaluation confirms that Reef can generate proofs for documents with 32M characters; the proofs are small and cheap to verify (under a second).
Paper: https://eprint.iacr.org/2023/1886
GraphRAG is All You need? LLM & Knowledge GraphGuy Korland
Guy Korland, CEO and Co-founder of FalkorDB, will review two articles on the integration of language models with knowledge graphs.
1. Unifying Large Language Models and Knowledge Graphs: A Roadmap.
https://arxiv.org/abs/2306.08302
2. Microsoft Research's GraphRAG paper and a review paper on various uses of knowledge graphs:
https://www.microsoft.com/en-us/research/blog/graphrag-unlocking-llm-discovery-on-narrative-private-data/
Unlocking Productivity: Leveraging the Potential of Copilot in Microsoft 365, a presentation by Christoforos Vlachos, Senior Solutions Manager – Modern Workplace, Uni Systems
1. THE BIZDEV
PORTAL
Or “why great Dx is not enough“
London / 9th of Nov 2018
Sophie Rutard
Head of API
Euler Hermes
2. WHO WE ARE – EULER HERMES
▪ B2B insurance, covering companies against loss of
payments since >100 years
▪ Global market leader, with ~850 bn € of global coverage
▪ ~6.000 Employees
▪ Part of Allianz – 2nd largest insurer worldwide
2
3. OUR API BACKGROUND
▪ We released our first API in Germany in 2007 (SOAP)
▪ Adapted it to worldwide needs in 2012 – backed by a
specialist consultancy team
▪ Once our customers have it they’re really happy!
▪ But our current setup isn’t really scalable
3
4. WHAT IS CREDIT INSURANCE?
4
Grey company
Green company
60 days terms
5. HOW DO WE DO IT?
5
Grey company
Green company Risk assessment and
continuous monitoring
THIS IS WHERE THE
API COMES IN!
Individual coverage for each buyer
6. A TYPICAL B2B SALES PROCESS
Prospecting
Mia is using
Salesforce
Sales & Order
mgmt
Katie is using a
bespoke warehouse
mgmt software
Credit mgmt &
accounting
Sabine is using SAP
Debt Collectiont
David is an external
broker, using
bespoke software.
Mark is an external
lawyer, using
bespoke software.
Although working in different departments and systems, all these business experts rely on valid and up-to-date
information provided by Euler Hermes. Our API is made to deliver the data where they need it - real-time.
PhotosbyMarilyTorresfromPexels
< API >
< API >
< API >
< API >
< API >
7. WHAT IT TAKES TO INTEGRATE
OUR API
Mia, Katie, Sabine, Mark
and David are brilliant
business experts.
They want to increase
efficiency, but they don’t
know much about APIs!
PhotosbyMarilyTorres,rawpixel.comandHiteshChoudharyfromPexels
Nina agrees to setup a project
and hire Nitin.
He is a great developer, but he
never heard of credit
insurance before…
They ask Nina for budget.
Being the CEO, Nina
understands the business
case, but she’s not an API
expert. She just needs
facts to agree on funding.
8. KEY REQUIREMENTS - BUSINESS
▪ Non-technical demonstration of the API’s business value
▪ Functional API catalogue
▪ Inspirational usecases beyond the API, helping to improve our
customer’s end-to-end Ux
▪ Support for estimation of project efforts and business case
calculation
▪ Easy communication channel to handle issues and to inform
about functional API enhancements
▪ Clearly defined contacts for 2nd level support
9. KEY REQUIREMENTS - DEVELOPERS
▪ Tutorials: Easy introduction to the business context
▪ Detailed explanation of key legal requirements
(audit proof logs, contractual obligations from the insurance product, etc.)
▪ Highlight business consequences of functional errors
▪ Clear link between API doc and related functional usecases
▪ Plus the usual elements:
▪ API key generation
▪ Functional API documentation
▪ API ref
▪ Sandbox environment
▪ Release notes
▪ Versioning policy
▪ SLA / performance tracking
▪ …
10. THE BIZDEVPORTAL MUST…
Enable a mixed team of biz and IT experts to be autonomous in delivering
something that:
▪ Enhances the end-to-end Ux
▪ Complies with legal requirements
▪ Is backed by professional support when needed
11. MY KEY MESSAGES
1. Know who your stakeholders are. Address them in their language.
2. If the business people don’t buy in, a developer won’t even have a look at
your dev portal.
3. The project will only suceed if developer and biz experts work together; The
BizDevPortal needs to support such collaboration.
12. Sophie Rutard
Head of API@EH
sophie.rutard@eulerhermes.com
LinkedIn: https://www.linkedin.com/in/sophie-rutard-7081baab
Currently hiring an API Senior Analyst
in Paris!
THANK
YOU!