TECHNICAL WRITER
Information Architecture for MyCover.ai
May 2024
overview
The MyCover.ai documentation required a comprehensive overhaul to address issues with its information architecture. My objective was to restructure the documentation to improve discoverability, navigation, and provide a seamless user experience for developers and partners.
the problem
The initial documentation presented several challenges:
- Disorganised structure: Information was hidden, making it difficult for users to locate resources efficiently.
- Unclear user journeys: The lack of a logical flow left users confused about where to begin or how to proceed.
- Not scalable: The structure was not built to accommodate future growth or additional content.
- Outdated content and layout: The design did not reflect the company’s branding, and some content was no longer relevant.
- Minimal guidance: Few onboarding resources were available, leaving users without clear instructions for starting.
My Process
- Audit and feedback collection:
- Conducted a detailed audit of the existing documentation.
- Collected feedback from internal teams and external users to identify pain points and prioritise features.
- Redesigning the information architecture:
- Developed a clear, scalable sitemap to organise content into intuitive sections.
- Introduced user-centric categories based on common use cases and developer needs.
- Content refinement:
- Updated outdated content and created new guides for better onboarding.
- Simplified complex explanations to improve clarity and accessibility.
- Visual improvements:
- Revamped the layout to align with the MyCover.ai brand guidelines.
- Integrated visual cues, such as icons and headings, to guide users more effectively.
- Testing and iteration:
- Conducted usability tests with a group of developers to validate the new structure.
- Refined the organisation and content based on feedback to ensure maximum efficiency.
the outcome
The revamped documentation transformed the user experience, making it easier for developers to onboard and navigate. Some key things we achieved include:
- Streamlined navigation: Users can now find relevant resources much faster compared to the previous structure.
- Improved onboarding: Step-by-step guides and categorised resources boosted user confidence and engagement during onboarding.
- Scalable architecture: The new structure supports the addition of future features and content.
- Positive feedback: The updated documentation has since received accolades for its clarity, design, and usability.