Skip to main content

Enhancing Search Functionality with the Smart Search Plugin

· 8 min read
Patricia McPhee
Patricia McPhee
Technical Content Manager

Search functionality is at the heart of a great user experience for technical documentation. Yet, modern search systems often overwhelm users with irrelevant results, straying far from their original purpose of helping users find information quickly and accurately. The Smart Search Plugin for Docusaurus 3.x reintroduces a concept that worked effectively decades ago in online help systems—metadata keywords—to deliver targeted, efficient, and intuitive search functionality.

Navigating the final lap: Crafting compelling release notes

· 9 min read
Patricia McPhee
Patricia McPhee
Technical Content Manager
Example banner
Navigating the final stretch of the release cycle requires the careful crafting of release notes, a task that, while complex, is crucial for every product update, no matter how small. These documents are more than just a formality; they're a vital conduit for clear communication about new features, enhancements, known issues, and fixes, preventing any last-minute confusion. More importantly, they're an opportunity to maintain customer excitement about the product, provided they're created with adherence to certain guidelines and standards for clarity and comprehension.

Crafting the ultimate technical writer portfolio

· 6 min read
Patricia McPhee
Patricia McPhee
Technical Content Manager

What's the recipe for a technical writer portfolio that doesn't just showcase your work but sets you apart from the crowd? How can you create a portfolio that resonates with potential clients or employers and showcases your multifaceted skills and adaptability? Let's delve in to unearth the secrets.