It all comes down to helping your API consumers integrate faster. When people decide to integrate with your API, they have a job they want to get done. They think your API could be the fastest path to solving it. But too often, building an integration with the API is as painful (or even more painful) as the original job. That’s counterproductive, to put it mildly. There are a hundred things your users would rather be doing than reading your API docs and writing basic integration code. The less you require of them, the happier they’ll be. And SDKs are the best tool for making sure your API remains unobtrusive.
The definition of an SDK is straightforward: It’s a library that surrounds your API and handles the boring parts of the integrating process, such as:
Constructing an HTTP request
Managing an authentication token
Handling retries
Parsing paginated responses
More powerful SDKs will go beyond request and response-handling basics and provide type safety and hinting in the integrated development environment (IDE). This means users don’t have to open a docs page; they’ll get all the information and feedback they need directly in their coding environment. It doesn’t get more efficient than that."
"Our research and evaluation shows that there are currently few design-specific AI tools that meaningfully enhance UX design workflows." -- #CalebSponheim#MeganBrown
#APIs#APIDocumentation#DX#TechnicalWriting#SoftwareDocumentation: "Finding the right balance between being too simple and too sophisticated isn't easy. You might get away with a generic onboarding how-to guide if your API focuses on one single feature (as OpenCage does). Otherwise, you need to craft different onboarding experiences for each one of the consumer use cases you want to support.
One thing that works for me is learning as much as I can from consumers before writing any API documentation. Then, I focus on the top use cases potential consumers are interested in. Since those will be the top entry points for most new API users, I prepare a tutorial for each. Each tutorial offers a safe environment where developers can easily sign up to use the API. Then, by following the steps in the tutorial they will end up implementing the integration that fulfills their use case."
I've always been very much in favour of UX and a11y over DX but, if you don't provide good DX, developers can produce some truly horrible UX and a11y. Can't win.
Why does that happen? Design and implementation costs evaporate as soon as an API is "finished" and consumers are using it. After that, the only thing that still matters to consumers is that the API behaves as it should. If not, they'll look for ways to fix the challenges they're having, and that's where support comes in.
Unless consumers can get all the information they need from the API documentation. If the API documentation can be the preferred method consumers use to troubleshoot their integrations, then you'll end up spending less on support. There will be less hand-holding required as consumers can fix their issues by themselves." https://apichangelog.substack.com/p/two-ways-to-influence-business-growth
Just turned the radio on. See two pileups on 30m CW. Look them up on dxsummit.fi. See that CB0ZA (Juan Fernandez Island), off the coast of Chile (see below) is calling CQ on 10115 kHz. I listen for a bit to see who he's calling, set my transmit frequency, and work them on the first call! That's my kind of DX. :) #hamradio#DX
Kirby meets @ddev - a Docker-based development tool that allows you to quickly set up and manage local development environments for your Kirby projects on Linux, Mac, or Windows. It’s pretty cool! 🚀 #dx
Is it your campus' #LMS, #CMS, #Portal, #Email, etc. that provide value, or your academic programs, faculty, research, etc.?
"Actors in the private sector [#HigherEducation] need to distinguish between the algorithmic technologies and data that are key to their intellectual-property and business model and the secondary ones that eventually support the former."
I just submitted my #DX Marathon entry for 2023 where 86 entities were counted in the Formula 100 antenna and power classification using only the CW mode! Want to see how you did this year? Visit https://dxmarathon.com submit your log and find out! The process is straightforward with only a few minor #accessibility barriers. #AmateurRadio#HamRadio
I am new to #amateurradio and on the way to my license. I am here for the #hamradio content to learn and to connect with other people. I am from #germany and also a fan of #draussenfunker.
I am interessed in #pota and #dx and can‘t wait to have my first #qso.
Just made my first international DX a few minutes ago on 10m. JG1HQA was on the air from Tokyo Bay calling CQ when I was scanning the band, and to my great pleasure he was able to receive my signal! #amateurradio#DX#ham_radio
#DX#DeveloperPortals#APIs#APIDocumentation#InformationArchitecture#TechnicalWriting: "An out-of-the-box developer portal can speed up your go-to-market. But after a quick launch, a developer portal that cannot be customized can become a roadblock to the long-term success of your API program. As the API portfolio grows and matures, your strategy will probably change and require more specific business experiences. In this case, a preset solution may no longer suit all the desired goals, and retooling might become necessary.
The Codat Docs team went through such a journey: they wanted to have more flexibility and control over their docs, and they built their own custom solution. Now, their documentation site is more resilient. With the help of the new landscape, large-scale changes can be managed on over three hundred pages of content without interrupting the existing user experience.
To mention another example, the Monite API Developer Portal uses a robust content management system that is exclusively tailored for developer documentation. The comprehensive resource was designed to provide an end-to-end self-service experience to developers.
The ability to extend and customize your developer portal plays a crucial role in executing on the API business strategy."