If you plan on implementing an assistant to help users set up your plugin, follow the rules set forth in this style guide.
In order to make your assistant user friendly and appealing, follow the recommendations listed below.
It is ideal to use fixed places for different types of information. To decide where certain bits of information should be displayed, they need to be categorised. Stick to the following rules to facilitate interaction with the assistant and provide users with all required information at the same time.
Never include links to external information, such as the manual or video tutorials. Assistants have to contain all necessary information and explanations to enable the user to carry out all settings and understand the options provided.
Exception: In case of certain technical necessities; e.g. when users have to be forwarded to markets or payment providers to enter/save/validate data there and there is no alternative solution.
Some information is mandatory and needs to be visible to users at all times. Use the
description sections to display explanations and introductory texts that users need to understand the task at hand.
Some information is considered optional, e.g. because it is self-evident to certain users. In this sense, optional information can exist in the form of specifications for password requirements. However, there is also information that is not optional in the strict sense, but cannot be displayed in its full length within a step of the assistant: This applies to explanations of options users can choose from and that require further explanation.
Use text in tooltips for such explanations. The following rules apply:
Consistency is important, so that users are not confused by the way they make choices within an assistant. The following rules should be applied uniformly throughout all assistants.