Documenting your App (Beta)

If you are creating apps that may be installed by anyone other than yourself, it's good practice to provide documentation of app requirements, features or behaviors, that may not be obvious to your intended users. You should also list the terms and conditions under which you are providing the app. Here are some general guidelines on what to include in your documentation.

What your app does, and the value it provides to your user

Describe any special requirements for the installation and use of your app.

When you create your properties, events, and functions in the Widget API, you provide brief descriptions that appear in the Settings panel (properties) or in the Code Panel autocompletion. However, the documentation you provide with the app is an opportunity to provide more detail about what users can do with your API and Velo by Wix . Remember to provide examples!

Properties that you add to the Widget API also appear in the Settings panel. Document what the user can or should change to make the widget work best for their site.

Each time you build your app, your app users will see a notification icon next to the app listing on their Wix Editor page. Let them know ahead of time what they can expect as far as the frequency and nature of updates. Let them know if your updates will be small tweaks to functionality and bug fixes, addition of major features, or complete redesigns.

The future is hard to see, but at least let them know that updates are a possibility.

Learn more about updates.

Describe the support that you provide and how customers can obtain it.

Tell your users the legal conditions under which they are using your app, and what information, site data, and user data your app accesses during installation and operation.