Concept for a Drupal text styleguide. It seems convenient to have a styleguide that developers can use. The styleguide supports the usability, because it increases the consistency throughout the application.

CommentFileSizeAuthor
Text style guide.txt1.8 KBbergco

Comments

batigolix’s picture

batigolix
Primary language Dutch
Location Utrecht
commented

as these guidelines are based on the work done on the menu, blocks and taxonomy modules it should get input from other drupal modules

it shoudl also somehow connect with the handbook styleguide (http://drupal.org/about/authoring) as they contain (in part) similar instructions

and it should get a place among the UI guidelines http://drupal.org/node/364002

this style guide could also be extended with examples of good use (with images?) to clarify the rules

bergco’s picture

bergco commented

I agree with all your comments, the document was meant to gather some reactions from the community about standardising screen text. I'll try to get a more decent version up later this week. In the meantime, all comments are welcome of course!

eigentor’s picture

eigentor commented

I like the text styleguide. Your recommendations are short and on point.
I second the idea of examples of good use (maybe some before/after cases?) with screenshots.
Ideal surely would be an example for each recommendation (uff, a lot of work...)

Personally I do not find it necessary for the text to be in the issue queue here. It does not have to be perfect to be on the docs pages. You'll find a lot of stuff there that needs work :P

So how about publishing a working version and gradually improving on it?
Maybe a structure of subsections could make sense - A general section, then one adressing button text, another for headings, still another for descriptions since all these are a little different in their objective.

When discussing text changes in the issue queue I found that guidelines are badly needed. Agreeing on a general attack plan saves lots of discussions.

eigentor’s picture

eigentor commented
Issue tags: +Needs text review
jhodgdon’s picture

jhodgdon
she/her
Primary language English
commented

If you add this information to the Handbook, I would like to suggest that it be added to the Standards section (either in an existing page or a new page):
http://drupal.org/node/360052

bergco’s picture

bergco commented
Assigned: Unassigned » bergco

Things to do:
- The empty text-pattern has to be changed in the documentation, as discussed in http://drupal.org/node/504428
- Add how URL's are displayed, as suggested by Xano

bergco’s picture

bergco commented

Things to do:
- The empty text-pattern has to be changed in the documentation, as discussed in http://drupal.org/node/504428
- Add how URL's are displayed, as suggested by Xano

bergco’s picture

bergco commented

Things to do:
- The empty text-pattern has to be changed in the documentation, as discussed in http://drupal.org/node/504428
- Add how URL's are displayed, as suggested by Xano

eigentor’s picture

eigentor commented

In order not to reinvent the wheel - I think there's quite a bit overlap with http://drupal.org/node/338208#voice
including a nice yes/no iconizing to make the examples easily scannable...

bergco’s picture

bergco commented

I've added the guide and the comments on this page to the Handbook, in the User interface best practices section. See http://drupal.org/node/501452. I'll keep this issue open for comments on the Handbook-page.

eigentor’s picture

eigentor commented

I changed the Title of the post, you just wrote "User interface best practises" To "User interface text best practises". I hope you don't mind...

What about breaking down the text into several chapters and adding examples?
Maybe we can also find some synergy with Addys Page (#9)...

eigentor’s picture

eigentor commented

Ah, great, it's live :)
I changed the Title of the post, you just wrote "User interface best practises" To "User interface text best practises". I hope you don't mind...

What about breaking down the text into several chapters and adding examples?
Maybe we can also find some synergy with Addys Page (#9)...

jhodgdon’s picture

jhodgdon
she/her
Primary language English
commented

I've made a few edits (mostly typographical, grammar, and punctuation, but also incorporating a comment into the first section).

I also changed the title back to "User interface best practices", because the page involves more than just text best practices. Put the information at the top into a section header to make this clearer.

eigentor’s picture

eigentor commented

I only read ui text recommendations in this. User interface best practices would be a bit general... But maybe Dalticom must bring light into this.

bergco’s picture

bergco commented

I think we should keep the title as it is, 'User interface best practices', because it contains other screen guidelines as well.

Should I mention this issue in the text, so people know where to leave their comments?

emmajane’s picture

emmajane commented
Status: Needs work » Fixed

This has now been incorporated into http://drupal.org/node/501452 and reviewed by jhodgdon, Bojhan and myself. Marking as "fixed." :)

Status: Fixed » Closed (fixed)
Issue tags: -Needs text review, -ui-text, -d7uxsprint

Automatically closed -- issue fixed for 2 weeks with no activity.

Issue tags: +Needs text review, +ui-text, +d7uxsprint

Restoring issue tags, see #2125755: System messages removed all issue tags during D7 upgrade.