Client Overview
Industry
Cloud-Native IT Operations
Region
Colorado, USA
Company Size
200+ Employees
Featured Solution
MadCap Flare UX Redesign, Custom Git Sync for Metadata
The Context
The client is a leader in cloud-native IT operations, providing automation tools that help organizations secure and manage endpoints. Their documentation is critical for user enablement and product adoption, but despite migrating content into MadCap Flare, their site faced several limitations.
Outdated templates, poor visual hierarchy, and a lack of brand-aligned themes made navigation and engagement difficult. Inaccurate “last updated” metadata reduced credibility, while static layouts and limited interactivity hindered usability.
They needed a modern, scalable document management system to enhance discoverability, reflect the brand, and maintain their internal team. We partnered with them to deliver a UX-driven redesign, custom Git-based metadata integration, and technical enhancements that transformed the documentation into a more engaging and reliable resource.
The Challenges They Faced
These hurdles stood between the team and a seamless, user-friendly documentation experience.
Outdated Templates
The default Flare template lacked visual appeal and UX sophistication, making the documentation feel static and uninviting.
Inconsistent Branding
The system lacked support for light/dark themes, and the overall design did not align with the brand, affecting visual consistency.
Complex User Experience
Content was hard to navigate due to unclear hierarchy and inconsistent structure, slowing down information retrieval.
Low User Engagement
Outdated design and navigation led to minimal interaction and poor adoption among users.
Untrackable Update History
“Last updated” dates reflected rebuild times rather than actual content changes, reducing trust in the documentation.
Inefficient Content Findability
Excessive or irrelevant links in the sitemap made it difficult for users to navigate and slowed down information findability.
How We Transformed The Experience
Here’s a snapshot of the core solutions we introduced, with several additional improvements applied throughout:
- Brand-Aligned Design & Dual Theme Implementation
- Implemented a light theme for standard use
- Implemented a dark theme to reduce eye strain in low-light environments
- Simplified navigation structure to improve user experience
- Applied clean typography, consistent layout, and brand-aligned UX components
- MadCap Template Implementation
- Restructured the landing page to align with the organization’s help center style
- Delivered a complete visual and structural refresh while retaining existing content
- Improved navigation with clear sectioning and a top-right search bar
- Ensured layouts, navigation, and content adapt seamlessly across all devices for a consistent, accessible experience
- Customized Flare skin and stylesheet with brand-specific colors, fonts, and palette
- Custom Features for Better User Experience
- Automated article publish dates synced with the latest Git commits, ensuring content is always up-to-date
- Clean, optimized sitemap with extraneous links removed for improved discoverability
- Enhanced navigation and freshness cues, helping users quickly access the most relevant information
- Reusable Framework & Authoring Efficiency
- Structured content, sections, and styles for full reusability
- Provided pre-defined templates for consistent visuals without coding
- Added responsive callout boxes, togglers, expandable images, and topic badges for richer interaction
- Designed sticky navigation and TOC for easier browsing
- Supplied an authoring guide to help writers maintain and scale documentation independently
- SEO-Optimized Documentation Architecture
- Implemented clean, semantic code with responsive layouts across devices
- Automated robots.txt and dynamic sitemap.xml generation at build
- Added post-build scripts to exclude irrelevant directories (/Resources/, /Archive/) from indexing
- Improved crawlability and visibility, enabling faster content discovery through search engines
- Comprehensive Support & Seamless Handover
- Delivered a detailed support guide covering custom features and templates
- Equipped writers with clear instructions to manage and expand documentation
- Enabled a smooth transition to independent, self-sustained workflows
Business Outcome
- Faster Information Access — Reduced time to find answers through clearer hierarchy and streamlined navigation.
- Increased Content Credibility — Commit-based metadata (via Git sync) delivered accurate “last updated” dates and restored user trust.
- Brand-Aligned, Accessible Experience — Dual themes and custom styling improved perceived professionalism and readability across contexts.
- Higher User Engagement — Interactive components and simplified navigation encouraged deeper exploration and repeat visits.
- Operational Efficiency — Reusable templates and authoring guidance cut update effort and lowered reliance on external resources.
- Lower Risk, Faster Recovery — Git sync and versioning reduced accidental loss and simplified rollbacks.
- Better Organic Discoverability — SEO-clean architecture and optimized sitemap improved search indexing and findability.
- Scalable Documentation Practice — The reusable framework and handover guide allow internal teams to manage and enhance documentation independently over time.
Summing Up the Impact
The transformation delivered a faster, clearer, and more engaging documentation experience for users, reducing the effort needed to find answers. With scalable architecture in place, the client’s team now keeps content accurate, relevant, and easy to maintain. It builds a foundation for sustainable growth and continuous improvement.
Our Resources
Testimonials
Our Partners
Are Documentation Gaps Slowing Down Your Team and Creating User Friction?
