VTEX
Introduction
Our VTEX Developer Portal caters front and backend developers integrating and building composable solutions for ecommerce with VTEX. Through our 753-endpoint API Reference and more than 2K guides, we empower over 35K developers from 80+ countries every month to create apps, new features, integrate external systems and customize ecommerce technology to suit their business needs.
Our VTEX Developer Portal was made from scratch by tech writers, with love, for everyone in tech. Completely custom built by our technical writing team, we partnered with Design, Computer Science and Computer Engineering university students in Brazil to deploy it - fomenting interest in documentation in early careers.
Our portal is fully open source, using docs as code techniques for managing and creating content collaboratively. We introduced multiple ways of getting user feedback, including, suggest Edits through GitHub, and other feedback forms and buttons.
Why nominated
Best API Reference Documentation
Features for devs and sandboxes:
- All endpoints include pre-filled cURL examples.
- Request and response bodies schemas are fully documented, as well as examples.
- Developers can test out calls directly in the API Reference pages.
- We offer an automatically updated and downloadable postman collection for all endpoints.
API Reference UX:
- Navigation menu allows filtering endpoints by operation.
- Includes endpoint-specific navigation search bar.
- Schemas contain nested and collapsible fields automatically rendered in a table with full descriptions, types and examples for (literally) thousands of properties.
Performance:
- Fully server-side rendered API reference pages allow optimal loading time.
Docs as code:
- Actions in our GitHub repository guarantee API reference quality and compliance with standards.
- All API information is centralized in an Open API Swagger 3.0 file stored in a public repo in GitHub.
- Fully open source API Reference hosted on GitHub with downloadable spec for seamless integrations directly through our Swagger 3.0.
Best Interface and Visual Design
Design and UX:
- Our Developer Portal is aligned with VTEX's minimal and elegant design system and aesthetics for establishing our brand identity for the developer community.
- Responsive pages are optimized for multiple screen sizes and are also mobile friendly.
- Sleek release notes' section includes filter options, search bar and timeline divided by year and month, with collapsible TLDRs for skimming what's important.
Content findability and information architecture:
- Organized into 5 entryway journeys, depending on the developer's expertise and task: API Reference, API guides, App development, Storefront development and VTEX IO apps.
- Includes collapsible menus.
- "Previous" and "Next" articles on page's footer.
Search engine customized for:
- Manual reprioritization of article ranking, to suit our tech writers' needs.
- Advanced search page for all results, equipped with filter options by content type.
Engaging with the community:
- Contributors are displayed on every guide page.
- Includes "suggest edits" feature, for everyone to contribute directly to our open-source code.
