Known Issues inform users about identified problems in the VTEX platform or products, their current status, and potential solutions (workarounds) or permanent fixes. We constantly update these articles so you can anticipate potential issues and know that our team is aware of them.
In this article, you’ll see the difference between Known Issues, other types of articles, and Product Improvements, as well as an overview of a Known Issue article.
Differences between Known Issues and Troubleshooting guides
When navigating VTEX documentation, it's important to understand the differences between article types, which have specific purposes. For example, Known Issues articles alert users to identified problems within the platform, providing updates, workarounds, or solutions. In contrast, Troubleshooting guides offer step-by-step instructions for fixing specific errors.
Below, find the goal, content focus and audience between Known Issues articles and other article types:
| Topic | Known Issue | Troubleshooting |
|---|---|---|
| Goal | Informing users of known issues within the platform and products and their workarounds or solutions. | Providing step-by-step instructions to solve specific problems or errors. |
| Content focus | Problem description, impact, workaround or solution, and status updates. | Troubleshooting steps, error messages, and potential causes. |
| Audience | All users who may be affected by the known issue. | Users experiencing specific problems or errors. |
| Article example | Benefits and taxes are not applied to services | My store’s Site Editor is not working |
Guidelines on identifying known issues or product improvements
Both known issues and product improvements intend to enhance the product. However, while known issues focus on solving existing problems, product improvements aim to add new features or enhance existing ones.
To better illustrate the difference between them, consider the following:
| Topic | Known issue | Product improvement |
|---|---|---|
| Definition | An identified problem or bug in the product or platform. | A proposed change to enhance the product or the platform's functionality, usability, or performance. |
| Focus | Fixing existing problems. | Adding new features or improving existing ones. |
| User impact | Negative impact on user experience or functionality. | Positive impact on user experience or functionality. |
| Example | A button on a page doesn't work as expected. | Adding a new feature to filter search results. |
Known Issue structure
| Article topic | Description |
|---|---|
| 1 - Title | Article title describing the issue. |
| 2 - Product name | Tag for the product affected by the issue. |
| 3 - Status | Tag describing the Known Issue status. These are the available status:
|
| 4 - Created on | Date when the article was created. |
| 5 - Updated on | Date when the article was last updated. |
| 6 - Summary | Section to describe the bug. |
| 7 - Simulation | Section to describe what steps are needed to reproduce the behavior. |
| 8 - Workaround | Section to describe the workaround for the issue, if there’s any. |