Plugin User Experience (UX)

General Advice

Great IntelliJ Platform plugins, like any other products, should bring significant value to users. When planning your work, talk and try to understand what your users need the most and prioritize crucial functionalities.

If you are unsure about an implemented solution, consider sharing the work in progress with a limited group of users (e.g., your colleagues or active community members) and gathering the feedback that will help you improve the final result. See the Custom Release Channels section for information on how to automate sharing the pre-release plugin versions.

Ease of Use

Plugins should be just easy to use. Ideally, all the features should work out of the box after the installation, without any special user interactions, like manually enabling crucial plugin features. Default settings should reflect the typical plugin usage in a standard project.

All the settings and actions should be easy to find and be placed in the proper settings or action group, e.g.:

• Framework plugin settings should be placed under the Settings | Languages & Frameworks

• Action marking a directory as a plugin-specific root type should be added to Mark Directory as... group

Plugins that are hard to configure with features that are hard to find may be quickly abandoned out of frustration.

Stability

Plugins that throw a lot of errors visible in the messages panel and execute actions resulting in incorrect behavior, e.g., generating incorrect code, are considered unstable and unreliable.

To improve the overall stability and minimize the risk of introducing regression issues, it is critical to implement functional tests with a low maintenance cost. It is a great safety net, which in the long term, will speed up your development and help you release new versions without the fear of breaking existing plugin features.

It's nearly impossible to develop software without bugs, so it is recommended to set up an issue tracker where users can report errors. In addition, it's worth implementing error reporting that allows sending reports directly from within the IDE, with all required information attached. To reproduce and understand problems in production, use logging consistently.

Performance

Even if a plugin works correctly and looks pleasing, poor performance will impact user satisfaction. Slow highlighting, code completion, code generation, and other features may break the user's workflow and cause frustration leading to plugin uninstallation. Always try to follow the performance tips described on the relevant topic pages, e.g., PSI Performance, Avoiding UI Freezes, Improving Indexing Performance.

Making as much functionality as possible working during dumb mode can also improve perceived performance.

Distribution Size

In addition to the plugin execution performance, it is recommended to optimize the size of the plugin distribution that is downloaded by users from JetBrains Marketplace. Users with a poor internet connection may cancel the download when they realize that it will take too long to wait for a plugin they are not sure will meet their expectations.

Consider the following techniques for optimizing the plugin distribution size:

• Decrease the number of dependencies. Check if the target platform includes utilities (like those mentioned in User Interface FAQ) or libraries you need and reuse them.

• Make sure no unneeded or multiple versions of the same dependencies are packaged in the plugin distribution.

• Optimize assets like icons, images, videos, etc.

• If large resources (e.g., SDKs, reference documentation) are needed only in specific setups, consider downloading them by the plugin on-demand instead of bundling them in the plugin distribution.

Obfuscation may also help reduce the distribution file size.

Consistent Behavior

When designing and implementing features, review existing functionalities of the IDE and plugins and design your features in a similar and consistent way. A consistent approach will make it easier for users to work with your plugin, increasing overall satisfaction.

If you implement custom language support, review and consider implementing extension points from the Additional Minor Features list so that your plugin provides an experience consistent with other plugins.

Consistent and Good-Looking UI

If a plugin UI significantly differs from the other application parts, it can feel alien to people and might be considered low quality or neglected. Review and follow the rules described in the UI Guidelines. Pay attention to icons and make them match the IDE style. Use the UI controls recommended for a given use case. Use UI Inspector to see how the existing UI is implemented.

High-Quality Texts

Bad-quality labels or texts with typos and grammatical errors make a bad impression. All the UI texts should follow the rules described in the Text section of the UI Guidelines. It is recommended to proofread the texts or use one of the spellcheck plugins.

Plugin Description and Presentation

The description on the plugin page is the place where users have the first contact with the plugin, and its content helps them to decide if it is what they are looking for. The description should be clear, polished, and follow the rules described in the JetBrains Marketplace documentation. See also this webinar about 5 tips for optimizing the JetBrains Marketplace plugin page.

Providing Translations

Translating the plugin may improve the experience and increase the adoption of non-English speaking users, for example, in the dynamically growing Chinese market. Even if translating is not planned in the nearest future, it is recommended to make the plugin ready for translation by following recommendations from the Internationalization section.