How to create exceptional bug reports

Your roadmap for crafting bug reports that get quick responses

Welcome to our guide on "How to Create Exceptional Bug Reports". In this article, we are going to help you simplify the process of creating helpful bug reports that truly make a difference!

As a valued user, your feedback is essential in helping us deliver top-notch software experiences. By following the principles written in this article, you'll not only make sure your issues are assessed and solved quickly but also contribute into  making our products more stable and reliable.

 


What makes a good bug report?

To achieve faster outcomes, it's important to create a bug report that follows some key principles. Such as:

    1. Add a clear Title for the issue

      • A clear and informative title serves as a valuable starting point for effective issue management, this ensures that the problem or topic at hand can be readily identified and addressed.

    2. Provide a thorough and clear description of the issue

      • Providing us with a detailed and clear description plays a pivotal role in enabling swift and accurate issue resolution by ensuring that the problem is fully understood and can be effectively addressed. Such as:

    Title: Feedback Feature is not working properly


    Description: We've been attempting to utilize the feedback feature to leave notes regarding a few misplaced labels. However, upon our attempts to use this feature, an error message consistently appears, preventing us from successfully adding any notes to the task


    3. Include relevant screenshots and videos to assist us in solving the problem

      • We advice to add any relevant screenshots and videos. They're a critical step and it is incredibly helpful for us to sort things out quickly. So, don't hold back – share away! 😉

    Please make sure every screenshot or video provided to us includes all the necessary information for the assessment of the issue 🙂 in case of doubt, please send us anything you might find useful and we will reach out to you if more information is needed.

    4. Give us a step by step on how to reproduce the issues

      • It's crucial for us to understand the issues you're encountering thoroughly. By having a detailed guide to reproduce the problems, we gain a clear and precise view of what's happening. This is like having a roadmap that guides us directly to the issue's source, allowing our team to investigate it effectively.


    Where can I submit a report?

    • We make it very easy for you as a user to submit a bug report, you can find our form here.
      But if you want quick access while using our products you can:

    Access it through the app dashboard...

      • click on your profile name -> Report issue...
        plat

    Access it through the drawing tool...

      • Help -> Report issue...
        app

    Access it through our app documentation...

      • If you are in our documentation page you can click on the header's option "Report issue"docs

     

    How do we deal with bug reports?

    When a ticket is opened it is crucial for us that we assess it as fast as possible to fix any issue that is bothering our users. Our mission is to understand, fix and deliver as fast and as efficiently as possible.

    How can you make this process faster?

    At times, our bug review and resolution process may extend beyond the anticipated time-frame due to the lack of essential information required for troubleshooting and resolution, ultimately impacting both parties involved.

    To minimize the risk of delayed assessments, we strongly recommend our users to meticulously follow this guide.