Documentation for an API can sometimes be just important as the service itself. We wanted to strike the right balance of technical information and onboarding simplicity to be able to serve audiences of all levels.
Aut nam rerum rerum provident ut. Non vel cumque. Vel ad veniam est qui dolorum. Quam aliquam delectus atque tenetur ex. Voluptates deleniti quod doloremque officiis necessitatibus beatae. Doloribus asperiores non. Omnis nam sit voluptatem cupiditate voluptas eum sit. Blanditiis
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Suspendisse varius enim in eros elementum tristique. Duis cursus, mi quis viverra ornare, eros dolor interdum nulla, ut commodo diam libero vitae erat. Aenean faucibus nibh et justo cursus id rutrum lorem imperdiet. Nunc ut sem vitae risus tristique posuere.
We started the project by talking to our targeted audience and understanding their needs. This phase also involved gathering as much information as we could on the current APIΒ documentation landscape.
β
β
β
Based on feedback from client and end users, we organized current and new content into a more logical hierarchy that allowed for scalability over time.
β
β
β
β
β
β
We developed a design system that adhere'd to the client's current style guide while also letting the content be primary focus.
β
β
β
Leveraging Readme's platform, we created a documentation experience that now allows Zenkey to quickly update, inform, and onboard developers onto their API.
β
β
Whether big or small, I'd love to help solve any design problem with you.