Create a platform that facilitates easy access to comprehensive API documentation and enhances the developer experience in integrating and utilising Emporix's services. The portal needs to address the diverse technical backgrounds of its users, ranging from novice to expert developers, ensuring that the documentation is both accessible and informative.
I conducted stakeholder interviews with the CPO, project manager, and front-end and back-end developers to discuss requirements.
I engaged with various developers to understand their needs, preferences, and pain points when using similar platforms. This direct feedback was invaluable in shaping the direction of the portal.
I mapped the typical user journey, highlighting painpoints and frictions, and identified opportunities.
Merged findings from the discovery phase to form a cohesive understanding of the essential features and potential improvements for the developer portal.
High-quality documentation: Developers consistently stressed the importance of comprehensive documentation that is easy to search.
Practical Examples: The desire for documentation to include practical, real-world examples and best practices indicates a need for more applied guidance and less theoretical content.
Response structure: The structure of a response is a crucial factor in deciding whether to adopt an API. It should be easily accessible and clearly presented.
Free Trial: Offer a free trial period. What users get with the trial and how long it is must be clear.
Learning path: Show users how they can learn more about our APIs. What kind of support do they get? Do they have tutorials, best practices, and examples to refer to?
Community Engagement and Support: The feedback indicated a significant interest in community engagement features, such as forums and Q&A sections, revealing a demand for collaborative spaces and peer support.
At this point, I laid out the portal's information architecture.
After defining the key user journeys, I designed user flows for each of them.
Transitioned from rough hand-drawn sketches to detailed wireframes, progressively refining the portal's layout and interface.
Created interactive prototypes that allowed stakeholders and potential users to navigate and experience the portal, ensuring design alignment with user needs and expectations.
Facilitated usability testing sessions with real developers, obtaining feedback on interface intuitiveness, feature accessibility, and overall experience.
Leveraged insights from the usability tests to make iterative improvements, polishing the portal's design and functionality based on real user feedback.
The core element of the landing page are:
• Highlights ‘quick Start Guide’
• Guides subdivision for users type (User guides, Developer Guides, Api References)
• List of use cases
• List of all available services
The Sign Up page is also used to deliver information about the free trial.
This page provides users access to manage their API keys.
Users can copy their IDs and regenerate their secret. The 'Get Started' CTA directs them to a quick start example code snippet.
The Quick Start Example allows users to quickly set up a project by copy and pasting a short code snippet.
This page is designed to provide administrators with an efficient interface to manage user access and roles within the system.
The top section of the page includes a tenant selector and a link to documentation.The main content area allows for adding new users, searching for existing users, and filtering by role (Admin or Users).
The table lists users with sortable fields for team member names, emails, tenant roles, and status, which indicates whether a user is active, pending, or requires action, such as email verification.
The actionable items include editing and deleting capabilities.
I design design system to account to help keep the look and feel of products and experiences consistent
