Director of Documentation & Localization · Content Strategy · Information Architecture · UX Influence
When I took ownership of the SolusVM documentation, it was clear the content needed a refresh to match our current standards and provide a more intuitive, consistent experience for users. The structure was uneven, the formatting varied from page to page, and the overall flow didn’t fully support the way users navigated the product. I saw an opportunity to bring clarity, cohesion, and a more modern approach to the entire documentation set.
As Director of Documentation & Localization, I guided the update and restructuring of the SolusVM documentation with a focus on usability and consistency. My work included:
• Updating content to align with current documentation standards
• Reorganizing the information architecture for clearer navigation
• Standardizing page layouts, formatting, and content patterns
• Improving readability and reducing friction in common workflows
• Collaborating with engineering to ensure accuracy and alignment
• Creating a more scalable structure for future updates
I began with a full audit of the existing documentation, identifying inconsistencies, outdated patterns, and areas where users were likely to get stuck. From there, I rebuilt the structure to create a more intuitive hierarchy, introduced standardized layouts for each page, and refined the content to be clearer, more concise, and more supportive. Once the initial structure was set, I collaborated with our systems team to migrate the content into the Hugo system with the rest of our documentation. I was then able to apply the needed updates to each document. I relied heavily on GitHub CoPilot for this project, which allowed quick progression. I fed CoPilot our style guide and had it review each page, pointing out what areas needed updates and then completed the changes. Once complete, I worked with Engineering to have a seamless transition and ensure that automation currently in place would continue.
• A more cohesive, modern documentation experience
• Clearer navigation and improved content hierarchy
• Consistent formatting and page layouts across the entire doc set
• Reduced user confusion and easier onboarding
• A documentation structure that supports ongoing updates and product growth
This project also allowed me to showcase the use of AI in documentation. While not every change CoPilot suggested was implemented, it made finding the issues much quicker and allowed me to move through large sets of documents with ease.
This is the previous documentation, which was very fragmented and didn't follow any Style Guide. It had often been updated by project managers and engineers without any cohesiveness and documentation for new features was often overlooked.
This is the new documentation (at 50% so the whole page shows), showing clear paths to move forward. Each page has been updated to follow our style guide and formatting rules.
This version of the SolusVM Documentation is now live.
