ValidMind Developer Library
Content Engineering
I transformed our disorganized developer resources into a comprehensive reference with a clean, modern, and mobile-responsive design.
ValidMind Documentation Redesign
Content Engineering
Content Architecture
Quarto
Frontend Development
HTML
Bootstrap CSS
I transformed ValidMind’s documentation from a sparsely populated and poorly organized site with no brand identity to a comprehensive and user-friendly experience with a clean, modern, and mobile-responsive design.
Along with authoring the bulk of ValidMind’s user guidance content, I also led the redesign and reorganization of ValidMind’s documentation, transforming a sparsely populated and poorly organized site with no brand identity to a comprehensive and user-friendly experience with a clean, modern, and mobile-responsive design.
As a newcomer to ValidMind and the risk management space, I knew I had an advantage others did not — I could approach both our product and user guidance content with curiosity and a fresh perspective, without the baggage of prior assumptions or preconceived notions as to how things should be done and presented.
Situation
Before I joined ValidMind, our documentation site was not only sparse in user guidance content, but any available content was not well organized or presented.
There were no clear user journeys, information on the same topics was scattered across multiple places in the documentation, and the overall structure was not intuitive. As a new user, using the documentation was a frustrating and confusing experience.
Solution
Along with cleaning up internal authoring practices and establishing proper file name conventions, usage of product variables, and other guidance detailed in the company style guide,2 I overhauled several key landing pages, made content placement more intuitive, and partnered with our frontend team to redesign the site’s theme.
I had an influence on nearly every page and section of the documentation. I’ll only cover here changes not detailed under Additional Redesigns.
Comparisons
Some comparisons of my influence on the documentation site:
Landing Page
The old landing page, which was cluttered, had poorly defined user journeys, and suboptimal display on mobile devices:3
I led the redesign of this landing page, collaborating cross-functionally with our frontend team to ensure the new design was both user-friendly and visually appealing as well as mobile responsive:4
User Guides
The old user guides portal, which not only had sparse content, buts somehow still felt crowded and cluttered:
The new user guides portal, filled with content I authored, and now featuring a cleaner experience thanks to my new collapsible sidebar Quarto Extension custom designed for this landing:5
5 validmind/documentation archive: validbeck/sidebar-slim
Support
The old support portal, which was not very helpful at all:
The new support portal, now with actions users can actually take, including visiting our custom Help Center:6
FAQs
The old FAQs, with outdated questions and answers, and lack of descriptive links to indicate relevant content:
The new FAQs, with updated and more detailed questions and answers, now featuring descriptive display of links to indicate relevant content:
Additional Redesigns
No Matches Found