Magnolia 5.6 reached end of life on June 25, 2020. This branch is no longer supported, see End-of-life policy.
Keep UI language brief and be specific. It's OK to rely on the user's common knowledge - don't state the obvious.
Name your app for its intended use. Be specific.
Guideline | ||
---|---|---|
Short, 2 x 12 characters max. | Pages | Web Page Editing |
Be unique, avoid repeating Magnolia native app names | Campaigns | Pages (campaigns) |
Use friendly language, avoid technical terms | Feeds | RSS Aggregator |
Be specific, one task per app | Google Sitemaps | Google Tools |
The app name is displayed under the icon in the app launcher. Short names that fit on one line work best.
A field label states the purpose of a field. Good labels are short and clear. The label is displayed to the left of the field in left-to-right languages.
A field description explains what a field is for and may shortly explain why the data is collected. Field descriptions are a form of context-sensitive online help.
Avoid useless descriptions that just add visual noise. When a field is common knowledge, such as "First name", you don't need a description.
You can also add a description to the dialog itself. For example, when a dialog collects private data, link to a privacy policy so the user understands that their data remains safe.