Content Guidelines

Before an app can be listed in the Rocket.Chat Marketplace, it must undergo a thorough review process. This process includes a comprehensive investigation into the app's authenticity, accuracy, and technical proficiency. Thus, it is crucial to ensure that your app contains high-quality content, appropriate screenshots, and optional videos that accurately describe its functionality.

To successfully navigate the publishing process, adhering to a specific set of guidelines regarding app content is essential.

Note: Please keep in mind that these guidelines are subject to change. If you have any questions or concerns about our review process, please contact us at [e-mail].

Our review team utilizes the following guidelines to evaluate the written content of your app and determine if it meets our standards for marketplace uploads. Adhering to these guidelines will help you avoid potential rejection or delays in the app review process. Additionally, following these guidelines will enable users to better comprehend the purpose, significance, and app usage, ultimately enhancing their experience with your app.

App Content Guidelines

The Rocket.Chat Marketplace offers a platform for your app to be featured alongside others, allowing users to easily search and filter through different categories of apps to find an app that caters to their business needs. This guide will provide you with information on how to make your app stand out in the Marketplace with the help of app content. To learn more about the visual guidelines for your app icon and images, please refer to our documentation on the Graphics Guidelines.

App Name

Choosing a well-thought-out name for your app is crucial in helping potential users understand its purpose and discover it in the Marketplace. Before finalizing a name, it is recommended to search the Marketplace for any existing apps with similar names. Keep the name as concise as possible, limiting it to two words.

• Keep it concise, straightforward, and distinctive

• Avoid lengthy and complex titles or abbreviations

• Avoid adding descriptive words to the app name

• Ensure that the app name is relevant and easy to remember

Categories

Select from a curated list of app categories that are specific to your app. This will improve the searchability and refine the app filtering process. You can refer to the comprehensive list of supported app categories in our Marketplace.

Avoid categorizing your app into too many categories, as it may dilute its value. If your app doesn't fit into any existing categories, reach out to us at [e-mail].

Supported Languages

List the languages that your app supports.

Author

The author's name and website link should be provided as the publisher details. If the publisher is an individual without a website, they can provide a link to their user profile page on GitHub.

Support

Support information, such as the support link or email address, should be included in this section. Users can be directed to the support desk portal if needed. If the publisher is an individual without a website or support email address, they can provide a link to the Issues page from the app repository on their GitHub account.

App Description Page

The App Description Page is where potential users can get a detailed understanding of what your app can do. It's a crucial space that can influence their decision. To maximize its impact, make sure to showcase your app's features and use relevant visuals. Here are some sections you can leverage to accentuate your app capabilities.

Short description Character Limit: 45 characters

Clearly explain your app's core function and the unique benefits it provides to users. You can address the question of what your app brings to the table. So, capture the essence of your app's magic concisely.

Here’s an example description of our Zapier app:

"Focus on what matters, while Zaps do the work for you!"

Long description

Character Limit: 1000 characters (ideally 500 - 600)

The long description should offer a concise overview of your app and its ability to address pain points. Its purpose is to convince users of the benefits of integrating with your app. To effectively resonate with your target audience, the integration should highlight its unique selling points. Use keywords that accurately describe your app's function and ensure the description effectively communicates its highlights. Approach the long description as a comprehensive FAQ, addressing any potential user queries about your app and its usage. Essentially, this section allows users to fully grasp the unique value your application brings to their workspace.

When crafting the long description, make sure to:

• Highlight the most significant features and benefits of your app to ensure quick comprehension by users.

• Clearly articulate the specific problems your app addresses, enabling users to understand its potential use cases.

• Elaborate on the additional features and benefits, showcasing the versatility of your application through various use cases.

It is important to note that the description should be concise, as most users only read between 300 and 500 characters. It is advised to avoid using technical jargon and to refrain from generically discussing the app or product.

You can refer to the long descriptions of our apps in the Marketplace. Use any one of them as your reference.

Technical documentation

Having clear and easily understandable technical documentation is crucial for the effective usage of your app. This documentation should make the app user-friendly and help users navigate it smoothly. Well-crafted instructions will assist end users in installing and using the app without any difficulties. So, it is important to note that user-facing support documentation will need to go through a review process.

To ensure a smooth installation process for users, it is important to incorporate the following recommended guidelines.

• Include detailed instructions that are easy to follow, while avoiding any steps related to internal testing.

• Provide links to other informative articles and frequently asked questions where necessary.

• To enhance user experience, be sure to include explicit instructions on how to utilize the app's features. This can be further clarified through the use of visual aids such as images or videos.

• Lastly, convey the value of the app and specify the purposes for which user data will and will not be utilized.

You can follow the structure suggested in the table below. Feel free to tweak the structure based on how it relates to your app.

Section	Description
About the app	Give a brief introduction to your app. Summarize what it offers in about 50-70 characters.
How does the app work	Provide details about what the app does, and how it does it in simple words.
Pricing model / compatible versions	State the pricing model of your app, if applicable. Mention the versions of your product the app is compatible with.
Who can use the app	Cover the aspects of access here. Provide details about who can use the app, and which roles have what access.
How will the app integrate with Rocket.Chat	A detailed section outlining how the app integrates with Rocket.Chat, meaning what is the expected behavior of the app within Rocket.Chat.
Capabilities of the app	Mention the entire list of your app capabilities concerning the Rocket.Chat integration, and highlight the benefits as well.
How to install the app	Step-by-step instructions for installing your app. Include screen captures or videos for any tricky steps.
How to configure the app	If your app has different settings, explain what they are in detail, and how to configure them.
How to get started with the app	Give a brief overview of the primary purpose of your app. Emphasize covering multiple use cases or the most significant ones to your users.
How to uninstall the app	Provide instructions for uninstalling your app. It's important to be fully aware of the consequences of uninstalling your app, particularly if it may cause data loss or other potential issues.
FAQ	Answer any frequently asked questions about the app that you anticipate or receive.

As an example, check out our ChatGPT technical document and the format we use as a benchmark for our app documentation.