Based on discussion here: http://groups.drupal.org/node/93659 we appear to have some agreement that the UI text best practices guidelines http://drupal.org/node/501452 and the Handbook styleguide http://drupal.org/node/338208 should be reviewed so that they are cohesive and also reference each other properly so people on one page will find the other.

If someone is up for reviewing and tweaking the two (this will mean documenting any divergences here so others can +1 or not on which should overrule), please assign this issue to yourself (and if you stop working on it, please unassign).

Thanks!

Comments

sun’s picture

sun
Primary language German
Location Karlsruhe
commented

subscribing

xano’s picture

xano
he/they
Primary language English
Location Southampton
commented

Rough copypaste from my g.d.o post:

At this moment the page you mention documents UI best practices. The page about writing UI texts is http://drupal.org/node/604342. There's a fundamental difference: UI is more than just text. It might be good to keep all text-related material on one page, and let the other focus on interface elements like forms and menus.

The audience for docs and the Drupal UI are not necessarily the same. The docs are for people who build sites using Drupal (developers, themers, site builders...). UI texts are for people who use a Drupal site (i.e. John Doe who wants to buy something from a Übercart webshop). Terminology should definitely be the same (logically), but parts of texts that are not specifically about Drupal don't have to follow the same writing standards.

I'm working on a suite of modules to review texts. One of the intended use cases is to apply the UI writing style guide to UI texts and see whether texts are written properly. The same setup (with a different style guide config) can be use to review handbook pages.

jhodgdon’s picture

jhodgdon
she/her
Primary language English
commented
Component: Correction/Clarification » Policies and Procedures
Issue summary: View changes
quietone’s picture

quietone commented
Status: Active » Postponed (maintainer needs more info)

The link for the UI text best practices guidelines, http://drupal.org/node/501452, in the issue summary is a 404. And the only comment here does not support the idea.

Is there anything to do here?