Adding a JIRA Issue Collector (feedback tool) to your MadCap Flare Documentation

In this article, I will show you how to add a custom JIRA Issue Collector to your MadCap Flare-based online documentation.

Why JIRA Issue Collector?

Adding a feedback mechanism to your web-based documentation is an excellent way to find areas for improvement. Every documentation site is different, so the requirements will likely vary. I would recommend that you do thorough research and try a few different tools before choosing. In our case, we wanted the following features in the toolset:

• easy to manage and maintain
• collects the URL and browser information, so we know precisely the area in the documentation the user is talking about
• automatically generates a JIRA ticket

We have been using the issue collector for a couple of months and are happy with it.

Why do you need to customize the issue collector?

After creating an issue collector in JIRA, you can add the generated code snippet to your Flare project right away without any additional customization. It will work. There are, however, a few things you may want to customize.