First of all, thank you for considering to report a bug, and helping us improve the quality and usability of our software. We will take the highest care to ensure the issue you experienced will be resolved in a timely manner.

Structure of a bug report

A bug report should have a specific structure to make it easy for the development team to understand and address the issue. The following are the key components that should be included in a bug report:

1. Title/Summary: A brief description of the problem that clearly and concisely communicates the issue.

2. Description: A detailed explanation of the problem, including any relevant context or background information. This section should include the steps to reproduce the issue.

3. Actual Behavior: A description of what is happening instead of the expected behavior.
4. Expected Behavior: A description of what should happen when the software is functioning correctly.

5. Severity: An assessment of how severe the issue is and the impact it has on the software's functionality. All issues will be handled in a timely maner. To help with assessing severity, answering following questions can help:

   1. Can the issue be consistently reproduced?
   2. Does the issue result in a crash of the software, without the ability to save work?
   3. Does the issue result in save file corruption?
   4. Does the issue have a workaround?

6. Screenshots/Attachments: Any screenshots or attachments that may be helpful in reproducing or understanding the problem.

   1. Screenshots of the Console log file
   2. Screenshots or recordings of the steps to reproduce, before and after situation and deviation from expected results
   3. A project export (ideally a Project + Assets export)

By following this structure, the development team can quickly understand the issue and take steps to resolve it. Users are encouraged to provide as much detail as possible, including any error messages or relevant log files.

How to to take a screenshot of the Console log files in Create

In Chrome

1. Go to options (3 dots on the top right of the window)
2. Go to "More Tools"
3. Go to "Developer Tools"
4. Go to the "Console" tab
5. Take a screenshot of the error messages, for example with the Windows snipping tool
   1. Go to Windows start menu
   2. Type "Snipping Tool"
   3. Open the Snipping Tool
   4. Take a new screenshot (eg. with Rectangular snip tool that will allow you to drag select an area)
   5. Save the screenshot as a file
   6. Attach this image to the bug report

Why are "steps to reproduce" so important, and what should they look like?

Accurate steps to reproduce a bug help the development team to identify the problem and resolve it more quickly. Without accurate steps, the team may not be able to replicate the issue and therefore may not be able to fix it. Accurate steps ensure that the team has a clear understanding of the problem, which ultimately leads to a more efficient and effective resolution.

In other words, only seeing the result of an issue or bug, might not give sufficient information or clues in order to find the actual cause of an issue.

The ideal "steps to reproduce" show the most efficient path to consistently reproduce a bug.

An example

Let's say Create has a bug where the "Save" button is not working. To provide accurate steps to reproduce this issue, a user might follow these steps:

1. Open Create and create a new project.
2. Add some text and images to the work instruction. (if this step is needed in order to reproduce the behavior consistently)
3. Click on the "Save" button in the toolbar.

Acutal behavior: Note that the work instruction is not saved, and the button does not respond to clicks.

Expected behavior: The project should save.

It is also possible that a particular bug only occurs in a specific project, in which case allowing the development team to gain direct access to the project, can be essential in order to find the source of the issue.

Exporting a project

Exporting a project in Create can be done under File > Export Project > Projects and assets.