Scaleway
About the Developer Portal
The Scaleway Developers website, integrated within the Scaleway Product Documentation site, provides extensive resources for leveraging Scaleway's cloud services. It includes detailed API documentation, developer tools like CLI, Terraform, and Ansible, and various SDKs. Clients can interact with Scaleway products through these APIs for tasks such as provisioning and managing cloud infrastructure, automating deployments, and integrating third-party services for enhanced functionality.
Why They Stand Out
Best AI-augmented User Experience in a Developer Portal
Scaleway uses Devana.ai, generative knowledge management AI software. The software enables businesses to easily create, deploy, and orchestrate reliable conversational agents.
We have integrated Devana into Scaleway Documentation, and Developers' websites offer personalized, real-time support and content recommendations, improving user engagement and satisfaction. It can also automate the generation of contextual documentation, ensuring information is up-to-date and relevant. This integration showcases a seamless, AI-driven user experience, making the documentation more intuitive and effective for all our clients.
Best Onboarding Experience in a Developer Portal
Our home page lists all the ways to use the API with developer tools and includes a comprehensive quickstart that intuitively teaches users how to perform basic API commands.
In this Quickstart, we explain the basic concepts necessary for understanding APIs, give detailed descriptions of possible error messages users might encounter, list all relevant Scaleway endpoints, explain how geographic regions and zones work, as well as how versions are managed.
Each product page has an introduction that explains what the product is and how to use it. They also include a dedicated quickstart, where we show how to configure environment variables, perform basic setup, and perform simple actions with the products via the API. Users can copy the relevant commands and replace placeholders with their values. Any additional information regarding technical limitations is also included in this section.
Furthermore, we include suggestions for additional content that might help users contextualize the product and its features. Users can also find ways to get in touch with the Scaleway community or the Scaleway support team for more help.
Also, every API documentation can be downloaded as a yaml file, facilitating automation and integration with various tools and frameworks. Since YAML is human-readable, it is also easier for teams to collaborate on API documentation. Developers, QA engineers, and technical writers can all contribute to and review the documentation.
Best Findability of Products in a Developer Portal
The Developers documentation website has a landing page that gathers Scaleway API documentation, developer tools like CLI, Terraform, and Ansible, and various SDKs. It serves as a hub to find all the relevant information for our clients.
When looking at the API documentation, it has been designed so that it is easy to use. It is structured and has a clear navigation. The product menu is sorted alphabetically, each page has a consistent hierarchy with a clear introduction, concepts, quickstart, and technical content. Each product page also features a downloadable Yaml file to parse the information in markdown via a text editor. We have different custom components with various colors, to alert, advise or inform our clients.
Sections are also logically categorized, including Quickstart guides, Authentication, Requests and Responses, and specific product APIs. Each API endpoint also includes detailed descriptions, usage examples, and curl commands for practical implementation.
In addition, by leveraging Algolia for search, the Developers' documentation website demonstrates exceptional product findability. Algolia has allowed us to get fast and relevant search results, and combined with features like autocomplete, typo tolerance, and query suggestions, we can ensure that developers can quickly locate the information they need.
In addition, we have a results preview which contributes to a smoother user journey as clients can quickly preview snippets of the content directly in the search results. This allows them to assess the document's relevance without needing to open it fully, saving time and effort. Algolia analytics provide us with valuable insights into tracking trends in search queries, which can reveal interests, changes in client needs, or content gaps.
What makes this Developer Portal excellent
Scaleway integrates advanced technologies like Devana.ai and Algolia to enhance user experience and satisfaction. Devana.ai enables the creation of intelligent conversational agents that offer personalized, real-time support and content recommendations.
Using Algolia for the search bar provides fast, relevant search results with features like autocomplete, typo tolerance, query suggestions, and result previews.
Both features ensure that users receive relevant assistance promptly, improving their overall experience.
The onboarding experience at Scaleway is thorough and user-friendly. The home page offers a comprehensive quickstart guide that teaches basic API commands. Detailed explanations of API basics, error messages, endpoints, geographic regions, and version management ensure users can quickly understand and utilize Scaleway's products and features. Product pages provide clear introductions, configuration instructions, and basic setup commands as well as additional content suggestions and links to support channels.
Scaleway’s developer documentation website is a well-organized hub for API documentation, developer tools, and SDKs. Its clear navigation, consistent hierarchy, and downloadable Yaml files contribute to a seamless user experience. Logical content categorization, including Quickstart guides, Authentication, Requests and Responses, and detailed product API information, makes it easy for users to find what they need.
