Rethinking our documentation
Blog post from SuperTokens
Documentation is a critical component of the user experience for developer tools, and this was particularly evident for the authentication solution SuperTokens, which had previously faced challenges with outdated and inconsistent documentation. To address user feedback about the confusing and fragmented nature of the existing documentation, the team undertook a comprehensive restructuring process. This involved reorganizing the content into two main layers: Documentation and References, with a focus on unified navigation, consistent layout, and logical grouping. The Documentation section now offers step-by-step guides that follow the natural progression of the authentication process, while the References provide detailed insights into SDKs and APIs. The restructuring efforts have led to a more streamlined user journey, reduced navigation complexity, and have been met with positive feedback from users. Future plans include enhancing the References section with improved examples, search capabilities, and integration with AI tools to further ease the development process.