This document discusses the importance of gathering user feedback throughout the API development process. It recommends conducting user interviews early on to understand needs and frustrations. It also suggests usability testing the API prototype to observe how users interact with it and identify issues. Throughout the development stages of concept, design, build, and manage, gathering feedback through methods like card sorting, beta testing, hackathons, surveys, and support channels can help validate the business, refine the product roadmap, and build a strong developer community. The overall message is that listening to users will help uncover blind spots and guide the API design in a positive direction.
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.
Your Developer Portal is the primary interface that developers will have with your company’s product. So what does your developer portal say about you? We’ll share what we’ve learned at BigCommerce about redesigning a developer portal that helps your developers–and your company–meet their goals.
Standardizing APIs Across Your Organization with Swagger and OAS | A SmartBea...SmartBear
In this webinar session, we showed why API standardization is important and how your organization can use SwaggerHub to overcome the most common challenges with making the move to the OpenAPI Specification.
Blood, sweat, and creating an API handbookPronovix
This talk describes the development of ABN AMRO’s API handbook, the single-source of truth for the development and management of internal and external API products.
Our company is moving towards an API-First culture and mentality. Streamlining the development process is key to enabling this. In the beginning, API development knowledge was not documented or centralized in one location. Accurate information was not available for developer teams and they were not aware of what exactly the process entailed.
My colleague and I began by making agreements on how the overall process works, describing it in an intuitive way, and then by making it open and accessible company-wide. This involved setting up and hosting face-to-face meetings or MS Teams calls with specialists to find out what was required
This talk describes our approach to gathering content from experts, defining and refining processes, obtaining feedback from readers, and redesigning the content in a more user-centric format.
From Enterprise SaaS to Self-Serve Api- the S.T.R.E.A.M. Framework for API La...Tiffany Xingyu Wang
Success stories like Twilio and Stripe set the blueprint for API-first businesses. However, what if you already succeed in enterprise SaaS models, and desire to drive growth through API? When I first started to optimize growth opportunities through API, I could not find a playbook out there. Therefore, together with Matt McLarty - Global Leader of API Strategy at Mulesoft (a Salesforce Company) - we want to write a step-by-step guide of the API launch strategy.
The content was first published at APIDays London in Oct 2020.
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
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.
Your Developer Portal is the primary interface that developers will have with your company’s product. So what does your developer portal say about you? We’ll share what we’ve learned at BigCommerce about redesigning a developer portal that helps your developers–and your company–meet their goals.
Standardizing APIs Across Your Organization with Swagger and OAS | A SmartBea...SmartBear
In this webinar session, we showed why API standardization is important and how your organization can use SwaggerHub to overcome the most common challenges with making the move to the OpenAPI Specification.
Blood, sweat, and creating an API handbookPronovix
This talk describes the development of ABN AMRO’s API handbook, the single-source of truth for the development and management of internal and external API products.
Our company is moving towards an API-First culture and mentality. Streamlining the development process is key to enabling this. In the beginning, API development knowledge was not documented or centralized in one location. Accurate information was not available for developer teams and they were not aware of what exactly the process entailed.
My colleague and I began by making agreements on how the overall process works, describing it in an intuitive way, and then by making it open and accessible company-wide. This involved setting up and hosting face-to-face meetings or MS Teams calls with specialists to find out what was required
This talk describes our approach to gathering content from experts, defining and refining processes, obtaining feedback from readers, and redesigning the content in a more user-centric format.
From Enterprise SaaS to Self-Serve Api- the S.T.R.E.A.M. Framework for API La...Tiffany Xingyu Wang
Success stories like Twilio and Stripe set the blueprint for API-first businesses. However, what if you already succeed in enterprise SaaS models, and desire to drive growth through API? When I first started to optimize growth opportunities through API, I could not find a playbook out there. Therefore, together with Matt McLarty - Global Leader of API Strategy at Mulesoft (a Salesforce Company) - we want to write a step-by-step guide of the API launch strategy.
The content was first published at APIDays London in Oct 2020.
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
Lessons Learned from Revamping Our Doc SitePronovix
Learn what went well and what didn’t, when Ilona, a technical writer, and Prabhjot, a software engineer, share the story of revamping the developer documentation website at Twitch. Some hints: getting it done required more than just engineering, content, and design. Together they learned how to “manage up” and that the whole project went better because they worked so well as a team.
The fact that there is no hand-written manual or specification for approaching API products has given rise to various API designs. Perhaps the reason why integrating with APIs is often dreaded. In this talk, you will learn how to approach API products. You’ll start treating APIs as first-class citizens, revenue drivers as opposed to a code by-product. You will learn the secrets of building APIs that developers love to use.
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!
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.
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.
apidays LIVE Helsinki & North - Designing embedded platforms: lessons from in...apidays
apidays LIVE Helsinki & North 2021 - APIs, Platforms, And Ecosystems - Transforming Industries And Experiences
March 15 & 16, 2021
The - sometimes surprising - benefits of open banking, open finance and beyond
Designing embedded platforms: lessons from industry success & failure
Jeremy Glassenberg, Director of Product, APIs at Deserve
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.
apidays LIVE Paris - Succeeding with API Programs by Kiran Nadgirapidays
apidays LIVE Paris - Responding to the New Normal with APIs for Business, People and Society
December 8, 9 & 10, 2020
Succeeding with API Programs
Kiran Nadgir, Head of APIs and UX Platforms at Silicon Valley Bank
apidays LIVE Australia 2021 - From apps to APIs: how no-code is transforming ...apidays
apidays LIVE Australia 2021 - Accelerating Digital
September 15 & 16, 2021
From apps to APIs: how no-code is transforming the tech industry
Carmen Chung, Senior Product Manager at Linktree
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
Building a solid API is a challenge but getting our APIs to be adopted by a larger audience, we quickly realized that having solid SDKs is the key element.
At Rubrik we have been developing SDKs to supplement our APIs for over 3 years and during this process we have been making sure our SDKs provide a seamless experience for end-users to consume. When breaking API changes occur during the development of our product.
The key takeaways of this session are:
* How to strategize SDK development against an ever-changing API
* Securely open-source your SDK development process
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
Pure APIs: Development workflows for successful API integrationsJosé Haro Peralta
APIs are the fundamental tenets of the Internet. They enable integrations between different services, and they power the servers that bring our applications to life. API integrations lay at the core of our API-driven world, and delivering successful API integrations is fundamental to sustain it. However, more often than not, API integrations tend to fail due to ineffective development workflows. In this presentation, I want to present various API development workflows that have helped me and my clients deliver successful API integrations. I’ll show how documentation-driven development, using mock servers, robust API testing frameworks, and API visibility tools can help to significantly reduce the chances of API integration failure and to keep errors under control.
Continuous Integration and Delivery at Shapeways (Matt Boyle)Nordic APIs
This is a session given by Matt Boyle at Nordic APIs 2016 Platform Summit on October 25th, in Stockholm Sweden.
Description:
We’ve spent a lot of time over the years at Shapeways building, honing, and improving our deployment and test process for our web properties and API. We started with straight-to-prod commits (which caused quite a bit of downtime!), graduated to working in two- and then one-week release cycles (which caused a lot of anxiety!), to where we are today: releasing 5-15 times a day, with automated testing, using continuous improvement and delivery best practices and tools. We’ve taken the complexity and anxiety out of our deployment process by implementing ChatOps, or using a bot to handle the sorts of tasks computers are great at, namely performing complex tasks repeatedly without error. This enables humans to focus on tasks that we’re uniquely suited for, namely solving complex problems and architecting reliable, resilient, and scalable solutions for our users. We’d love to share some of what we’ve learned along the way, from building automated testing tools, to selecting and implementing open-source solutions, to how we took our global deployment process from one hour to 4 minutes. We’d also like to share our vision of the future: what inspires us, what we hope to achieve in the coming weeks, months, and years, and how we’re going about doing it.
apidays LIVE Hong Kong 2021 - Automating the API Product Lifecycle by Jeremy ...apidays
apidays LIVE Hong Kong 2021 - API Ecosystem & Data Interchange
August 25 & 26, 2021
Automating the API Product Lifecycle
Jeremy Glassenberg, Product Lead, APIs at Docusign
API Product Management - Driving Success through the Value ChainApigee | Google Cloud
We Will Discuss »
- Managing API products to maximize success for direct and indirect users in the value chain
- Planning, building, and evolving an API product at all stages of the product life cycle
- Evaluating and validating your API design and functionality and iterating to build a superior and differentiated product
Lessons Learned from Revamping Our Doc SitePronovix
Learn what went well and what didn’t, when Ilona, a technical writer, and Prabhjot, a software engineer, share the story of revamping the developer documentation website at Twitch. Some hints: getting it done required more than just engineering, content, and design. Together they learned how to “manage up” and that the whole project went better because they worked so well as a team.
The fact that there is no hand-written manual or specification for approaching API products has given rise to various API designs. Perhaps the reason why integrating with APIs is often dreaded. In this talk, you will learn how to approach API products. You’ll start treating APIs as first-class citizens, revenue drivers as opposed to a code by-product. You will learn the secrets of building APIs that developers love to use.
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!
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.
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.
apidays LIVE Helsinki & North - Designing embedded platforms: lessons from in...apidays
apidays LIVE Helsinki & North 2021 - APIs, Platforms, And Ecosystems - Transforming Industries And Experiences
March 15 & 16, 2021
The - sometimes surprising - benefits of open banking, open finance and beyond
Designing embedded platforms: lessons from industry success & failure
Jeremy Glassenberg, Director of Product, APIs at Deserve
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.
apidays LIVE Paris - Succeeding with API Programs by Kiran Nadgirapidays
apidays LIVE Paris - Responding to the New Normal with APIs for Business, People and Society
December 8, 9 & 10, 2020
Succeeding with API Programs
Kiran Nadgir, Head of APIs and UX Platforms at Silicon Valley Bank
apidays LIVE Australia 2021 - From apps to APIs: how no-code is transforming ...apidays
apidays LIVE Australia 2021 - Accelerating Digital
September 15 & 16, 2021
From apps to APIs: how no-code is transforming the tech industry
Carmen Chung, Senior Product Manager at Linktree
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
Building a solid API is a challenge but getting our APIs to be adopted by a larger audience, we quickly realized that having solid SDKs is the key element.
At Rubrik we have been developing SDKs to supplement our APIs for over 3 years and during this process we have been making sure our SDKs provide a seamless experience for end-users to consume. When breaking API changes occur during the development of our product.
The key takeaways of this session are:
* How to strategize SDK development against an ever-changing API
* Securely open-source your SDK development process
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
Pure APIs: Development workflows for successful API integrationsJosé Haro Peralta
APIs are the fundamental tenets of the Internet. They enable integrations between different services, and they power the servers that bring our applications to life. API integrations lay at the core of our API-driven world, and delivering successful API integrations is fundamental to sustain it. However, more often than not, API integrations tend to fail due to ineffective development workflows. In this presentation, I want to present various API development workflows that have helped me and my clients deliver successful API integrations. I’ll show how documentation-driven development, using mock servers, robust API testing frameworks, and API visibility tools can help to significantly reduce the chances of API integration failure and to keep errors under control.
Continuous Integration and Delivery at Shapeways (Matt Boyle)Nordic APIs
This is a session given by Matt Boyle at Nordic APIs 2016 Platform Summit on October 25th, in Stockholm Sweden.
Description:
We’ve spent a lot of time over the years at Shapeways building, honing, and improving our deployment and test process for our web properties and API. We started with straight-to-prod commits (which caused quite a bit of downtime!), graduated to working in two- and then one-week release cycles (which caused a lot of anxiety!), to where we are today: releasing 5-15 times a day, with automated testing, using continuous improvement and delivery best practices and tools. We’ve taken the complexity and anxiety out of our deployment process by implementing ChatOps, or using a bot to handle the sorts of tasks computers are great at, namely performing complex tasks repeatedly without error. This enables humans to focus on tasks that we’re uniquely suited for, namely solving complex problems and architecting reliable, resilient, and scalable solutions for our users. We’d love to share some of what we’ve learned along the way, from building automated testing tools, to selecting and implementing open-source solutions, to how we took our global deployment process from one hour to 4 minutes. We’d also like to share our vision of the future: what inspires us, what we hope to achieve in the coming weeks, months, and years, and how we’re going about doing it.
apidays LIVE Hong Kong 2021 - Automating the API Product Lifecycle by Jeremy ...apidays
apidays LIVE Hong Kong 2021 - API Ecosystem & Data Interchange
August 25 & 26, 2021
Automating the API Product Lifecycle
Jeremy Glassenberg, Product Lead, APIs at Docusign
API Product Management - Driving Success through the Value ChainApigee | Google Cloud
We Will Discuss »
- Managing API products to maximize success for direct and indirect users in the value chain
- Planning, building, and evolving an API product at all stages of the product life cycle
- Evaluating and validating your API design and functionality and iterating to build a superior and differentiated product
INTERFACE, by apidays - The 8 Key Components of a Modern API Stack by Iddo G...apidays
INTERFACE, by apidays 2021 - It’s APIs all the way down
June 30, July 1 & 2, 2021
The 8 Key Components of a Modern API Stack
Iddo Gino, CEO at RapidAPI
Dependency Down, Flexibility Up – The Benefits of API-First DevelopmentNordic APIs
The tech industry is moving toward cloud and serverless infrastructures. This shift isn’t without its challenges. Complexity is growing in microservices stacks, containerization, and continuous delivery. With a code-first approach, services can be vulnerable to development bottlenecks and program breakage, especially as complexity grows. This is where API-first development comes in.
The main difference between code-first and API-first is that instead of starting with code, API-first programs begin with design, planning, mocks, and tests. Having a planned infrastructure during development and before implementation allows new features to be built as independent services. So, when a particular service is broken or overloaded, remaining services can still function successfully.
In this talk, Ankit Sobti will discuss how an API-first approach creates the backbone to robust, powerful programs that are resistant to breakage. In addition, he will walk through using mocks and tests to optimize feedback in early development, and share concrete examples of API-first development. By the end of this session, you will understand why and how API-first has the potential to create higher functioning and more flexible systems in the future.
Win More Customers With Embedded AnalyticsPoojitha B
Learn how you can provide superior customer experiences with embedded analytics with 7 easy steps. When it comes to embedded analytics there are many aspects to consider when it comes to the experience of your end-users.
Considerations For an API Strategy - Ronnie MItra API Architect Layer 7 Londo...CA API Management
API Management is becoming increasingly important as more and more organisations need to expose their data and application functionality to internal and external developers. Exposing APIs empowers these organisations to engage customers in innovative new ways, create new revenue opportunities and transform their businesses into platforms. But how do you ensure your APIs are exposed securely? How do you create, maintain and update different versions of your APIs? How do you throttle usage, meter requests and monitor API health?
The Global Influence of Open Banking, API Security, and an Open Data PerspectiveRogue Wave Software
Open Banking is being driven by regulation in Europe, however, it is ultimately about expanding consumer choice in financial services. Open Banking provides opportunities for financial services and FinTech companies as well as consumers. In this webinar, we’ll examine the influence of Open Banking across the globe and the key differences between regulation-led and market-led initiatives. We’ll also explore essential security standards in Open Banking and how they contribute to a secure Open Banking API interface.
Applying a Developer-Centric Approach to API Design from API Architect Ronnie...CA API Management
Designing an API from scratch can be a daunting task, but focusing on developer experience (DX) can act as a guiding light for API designers. In this session, we will explore the topic of interaction design and how it is changing the way we design web APIs today.
Growth Hacking APIs: What role do APIs play in your growth strategy.
There’s been lots of buzz in the tech startup space about “growth hacking” – what is it? how is it related to development? how is it related to marketing?
At it’s core, growth hacking is about finding a strategy for growth within the parameters of scalability and replicability, driven by product and inspired by data. Growth hacking’s core is based in marketing but driven by product.
Once the definition is clear, the question then becomes: without a UI to lean on, how does one “growth hack” an API?
At last year’s Nordic API conference, Guillaume Balas from 3Scale presented several typologies of an API, namely API is the product, API projects the product, API promotes the product, and API powers the product.
This presentation will elaborate on and reframe those typologies in the context of marketing and growth hacking of an API. We will examine the circumstances where an API is actually a growth hack in of itself, and where it is in need of growth hacking in order to make the business model behind it succeed.
The presentation will use core concepts of strategic marketing – such as positioning, pricing, targeting, promotion, product and distribution – to create a framework for either growth hacking an API or developing an API as a key tactic in a growth strategy.
APIs used to be a technical implementation detail reserved for developers and architects. In the Web age, APIs make more business sense than ever before. This presentation gives a ring side view of How to Craft Business Strategy around APIs.
Dev Dives: Unlock automation adoption with UiPath AppsCristina Vidu
In this developer-focused deep dive session, you will learn how to build modern and intuitive low-code applications using UiPath Apps. UiPath Partner, Ashling Partners, and our experienced Sales Engineer Silvana Schmitt will share UX and technical best practices for app development and show you how to implement them in a live build. This session is intended for a technical audience and requires a preliminary understanding of the UiPath Platform. Both new and seasoned UiPath Apps developers are welcome.
📕 During the session we will cover:
What is UiPath Apps?
Identifying Apps Use Cases Within your Organization
App Creation Framework (Ashling Partners)
Demo - Care Management App
Best Practices
BONUS: Get a Ready-to-Use Polling App.
Speakers:
👩💻 Silvana Schmitt, Sales Engineer @UiPath
👨💻 David Kroll, Director, Solutions Engineering @Ashling Partners
INTERFACE, by apidays - APIs: the next 10 years
June 8, 9 & 10 2022
APIs for Scaling Enterprises: Setting and Applying API Standards
Jeremy Glassenberg, Product Management Lead, APIs at Docusign
------------
Check out our conferences at https://www.apidays.global/
Do you want to sponsor or talk at one of our conferences?
https://apidays.typeform.com/to/ILJeAaV8
Learn more on APIscene, the global media made by the community for the community:
https://www.apiscene.io
Explore the API ecosystem with the API Landscape:
https://apilandscape.apiscene.io/
Deep dive into the API industry with our reports:
https://www.apidays.global/industry-reports/
Subscribe to our global newsletter:
https://apidays.typeform.com/to/i1MPEW
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
Dev Dives: Train smarter, not harder – active learning and UiPath LLMs for do...UiPathCommunity
💥 Speed, accuracy, and scaling – discover the superpowers of GenAI in action with UiPath Document Understanding and Communications Mining™:
See how to accelerate model training and optimize model performance with active learning
Learn about the latest enhancements to out-of-the-box document processing – with little to no training required
Get an exclusive demo of the new family of UiPath LLMs – GenAI models specialized for processing different types of documents and messages
This is a hands-on session specifically designed for automation developers and AI enthusiasts seeking to enhance their knowledge in leveraging the latest intelligent document processing capabilities offered by UiPath.
Speakers:
👨🏫 Andras Palfi, Senior Product Manager, UiPath
👩🏫 Lenka Dulovicova, Product Program Manager, UiPath
UiPath Test Automation using UiPath Test Suite series, part 3DianaGray10
Welcome to UiPath Test Automation using UiPath Test Suite series part 3. In this session, we will cover desktop automation along with UI automation.
Topics covered:
UI automation Introduction,
UI automation Sample
Desktop automation flow
Pradeep Chinnala, Senior Consultant Automation Developer @WonderBotz and UiPath MVP
Deepak Rai, Automation Practice Lead, Boundaryless Group and UiPath MVP
JMeter webinar - integration with InfluxDB and GrafanaRTTS
Watch this recorded webinar about real-time monitoring of application performance. See how to integrate Apache JMeter, the open-source leader in performance testing, with InfluxDB, the open-source time-series database, and Grafana, the open-source analytics and visualization application.
In this webinar, we will review the benefits of leveraging InfluxDB and Grafana when executing load tests and demonstrate how these tools are used to visualize performance metrics.
Length: 30 minutes
Session Overview
-------------------------------------------
During this webinar, we will cover the following topics while demonstrating the integrations of JMeter, InfluxDB and Grafana:
- What out-of-the-box solutions are available for real-time monitoring JMeter tests?
- What are the benefits of integrating InfluxDB and Grafana into the load testing stack?
- Which features are provided by Grafana?
- Demonstration of InfluxDB and Grafana using a practice web application
To view the webinar recording, go to:
https://www.rttsweb.com/jmeter-integration-webinar
Smart TV Buyer Insights Survey 2024 by 91mobiles.pdf91mobiles
91mobiles recently conducted a Smart TV Buyer Insights Survey in which we asked over 3,000 respondents about the TV they own, aspects they look at on a new TV, and their TV buying preferences.
Key Trends Shaping the Future of Infrastructure.pdfCheryl Hung
Keynote at DIGIT West Expo, Glasgow on 29 May 2024.
Cheryl Hung, ochery.com
Sr Director, Infrastructure Ecosystem, Arm.
The key trends across hardware, cloud and open-source; exploring how these areas are likely to mature and develop over the short and long-term, and then considering how organisations can position themselves to adapt and thrive.
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.
Software Delivery At the Speed of AI: Inflectra Invests In AI-Powered QualityInflectra
In this insightful webinar, Inflectra explores how artificial intelligence (AI) is transforming software development and testing. Discover how AI-powered tools are revolutionizing every stage of the software development lifecycle (SDLC), from design and prototyping to testing, deployment, and monitoring.
Learn about:
• The Future of Testing: How AI is shifting testing towards verification, analysis, and higher-level skills, while reducing repetitive tasks.
• Test Automation: How AI-powered test case generation, optimization, and self-healing tests are making testing more efficient and effective.
• Visual Testing: Explore the emerging capabilities of AI in visual testing and how it's set to revolutionize UI verification.
• Inflectra's AI Solutions: See demonstrations of Inflectra's cutting-edge AI tools like the ChatGPT plugin and Azure Open AI platform, designed to streamline your testing process.
Whether you're a developer, tester, or QA professional, this webinar will give you valuable insights into how AI is shaping the future of software delivery.
13. 1 x
10 x
100 x
Design Development Release
Prototyping:
fixing bugs early reduces costs
Source: Forbes
Stage of product lifecycle
Cost to
fix bug
14. Usability test
Observe how they use your APIs
1. Define scope + tasks
2. 5 testers = 85% of issues found
3. Think aloud + share screen + webcam
4. Observe, listen, record
5. Incentives (e.g. vouchers)
15. Lessons learned: your documentation must be
easy to find, easy to use
After usability test:
1. Reduced # of clicks
2. Select languages + SDKS
3. Copy code to clipboard
... and much more traffic!
16. Lessons learned: faster first API call
After usability test:
Shoot the APIs from the platform, before writing a single line of code
Try it out!
21. Beta testing
Your moment of truth
• Production-ready apps
• In-depth review
• Inconsistencies, performance issues
• Limited audience (can be external +
internal) & time range
22. API Journey
< / >
Survey
Metrics
Plug-in
Support
Concept
Design
Build
Manage
23. 75% of API users
would report API
performance /
quality issues
(The State of API 2019, Smartbear)
Open support
channels
24. Lessons learned: be fully transparent
After support feedback: APIs data collections (test environment)
25. Lessons learned: simplify the onboarding
After support feedback: guide users through each step of the journey
28. Master the feedback
you must
Hackathons
Unleash the power of your APIs
1. Direct observation
2. Support questions
3. Bug Hunter game
4. Team interviews
5. Surveys
6. Metrics
7. Follow-ups
29. API Journey
< / >
Usability test
Card sorting
Experts
Beta testing
Hackathon
Survey
Metrics
Plug-in
Support
User
interviews
Concept
Design
Build
Manage
30. 30
“Your
customers are
your compass. Listen to
their frustrations, and
they’ll guide you to your
next amazing feature ”
- Stephanie Briones, Zapier -