We’ve all been there. You’re using some documentation and want to tell a company something it — be it praise, a complaint, or request. You pause, hovering over the comments widget and wonder: “Should I bother? Will anyone listen?”
On the MuleSoft Documentation team, we are always listening. Whether it’s on publicly available documentation source, social media accounts, or analysis of ratings, comments, and surveys, the MuleSoft Documentation team wants to understand and respond to our customers’ needs. Here are a few ways you can reach out to us to give us your feedback.
Because our documentation repository is publicly visible, you can directly add to our documentation. Each top-level node in our table of contents maps to a Git repository that follows the naming convention mulesoft/docs-. For example, the Mule runtime engine documentation is publicly available here: https://github.com/mulesoft/docs-mule-runtime. You’ll find instructions for completing a lightweight contributor’s agreement, and the ability to submit a pull request that we will promptly review.
Pageviews, ratings, and comments
Pageviews, ratings, and comments are the core of our documentation evaluation. This data tells us whether customers are finding the documentation content valuable and if that content is helping them complete their goals.
Every page of MuleSoft documentation contains a rating and comment widget. We take these customer communications seriously:
- Every comment automatically becomes a work item in Jira. Each work item is prioritized and scheduled by the writer responsible for that topic. Customer concerns and suggestions are always our #1 priority.
- Ratings are regularly reviewed in coordination with pageviews and other data, and patterns are assessed. We use this data to identify opportunities for improvement or content that customers use most. This analysis helps us develop and adopt best practices.
We take action based on comments and ratings, including adding more examples, improving the structure and content of connector documentation, and providing a search-by-date feature for release notes to help customers find the latest changes.
More changes are in the works, from better landing pages to improvements in search. We’ll share news about these changes on Twitter and elsewhere as they roll out.
Periodically, we add a customer poll to each page of our documentation website. Regular survey data helps us measure our progress over time.
We are excited about both traditional and new ways we can help customers find the content they need, where and when they need it. We look forward to hearing from customers so we can continue to improve the information experience.
Please reach out to us using any of the above methods to provide us with feedback on current documentation.