JetBrains Marketplace
 
Start Selling Plugins

Documentation page

Last modified: 27 January 2025

If your plugin requires more than just a landing page with a list of features, publish user-facing documentation either as a separate website or under the Documentation tab of your plugin's page.

Unlike Custom pages, the Documentation tab is not a single page, but a full-fledged help instance with a structure, table of contents, and in-topic navigation. Here are examples of plugins with a Documentation tab: Grazie Professional, Rust, and Edu Tools.

Why you should consider investing in writing documentation for your plugin:

  • Documentation makes your plugin more discoverable and searchable. When product documentation is online, external search engines will bring it to everyone who types the keywords into the search query.

  • Documentation helps you effectively communicate the features of a plugin, allowing your users to understand how it works from the start.

  • Documentation is a good way to support your current users. If they find answers in the documentation, this will decrease your support load, which is crucial for smaller teams.

  • Comprehensive and well-structured documentation often translates to a higher rating for the plugin.