Problem/Motivation

Module developers are expected to name things and to provide UI texts but there is little guidance on it. In some cases guidance exists (for example for the format and goal of a hook_help text) but module developers are often not aware of it. In other cases, there is a general understanding, but it's not formulated so that others could follow it in future (for example how to phrase the wording of some buttons). And then there are points where it is not clear whether there is a general understanding (for example whether or not to add a menu item for an admin page).

While Drupal has Coding Standards https://www.drupal.org/coding-standards that detail how long a line of code should be or how to name a variable, we have no such standards to describe how long a module description should be (before it breaks of on the Extend page), or how to name a page or a tab.

Similarly structured UI Standards (or at least UI Text Standards) would allow both core and contrib developers to provide more consistent UIs, and therefore a more consistent UX.

Proposed resolution

Compile UI Standards (or UI Text Standards) in similar structure as the Coding Standards, and make developers aware of them in the similar way.

Remaining tasks

First we need to get an overview over what type of UI texts (titles, buttons, labels, help texts, etc.) there are, whether there is an agreed format, and whether some guidance already exists.
Then we could turn that into one list, that at least describes the current status and that could be used already now by module developers as a starting point.

We can then improve that list by formulating missing guidance and where necessary decide on areas that currently seem to be done in an ad-hoc manner.
Such a UI Standard can then be used to identify and fix inconsistency in Drupal Core as well.

Comments

ifrik created an issue. See original summary.

PieterDC’s picture

I'm in favor.

The current UI text guidelines can be found at https://www.drupal.org/node/604342.

ifrik’s picture

Help text standards - as used by the Documentation Working group for hook_help texts are here: https://www.drupal.org/documentation/help-text-standards

ifrik’s picture

Work in progress: an unfinished list of UI texts, the formats they are currently in and whether there is any guidance: https://docs.google.com/spreadsheets/d/1RqKu2iPhua9XAtHci1xDsdhdBbED05DN...

ifrik’s picture

Issue tags: +sprint
ifrik’s picture

Issue tags: +DevDaysMilan

I'll work before and during DevDaysMilan, and then hopefully we can sit together with a few people and think about whether we can give a more consistent guidance to be added to the Coding Standards.

Version: 8.2.x-dev » 8.3.x-dev

Drupal 8.2.0-beta1 was released on August 3, 2016, which means new developments and disruptive changes should now be targeted against the 8.3.x-dev branch. For more information see the Drupal 8 minor version schedule and the Allowed changes during the Drupal 8 release cycle.

tkoleary’s picture

Priority: Normal » Major
Issue tags: -DevDaysMilan
ifrik’s picture

Issue tags: +DevDaysMilan

tkoleary: Please don't remove the tag for sprints during which work was done on an issue.

Bojhan’s picture

I am unsure what this needs beyond what is already written in our Human Interface Guidelines.

tkoleary’s picture

@ifrik

Sorry. Thought that was no longer relevant since it was over, but I see how it makes sense to reference it.

Version: 8.3.x-dev » 8.4.x-dev

Drupal 8.3.0-alpha1 will be released the week of January 30, 2017, which means new developments and disruptive changes should now be targeted against the 8.4.x-dev branch. For more information see the Drupal 8 minor version schedule and the Allowed changes during the Drupal 8 release cycle.