[documentation] [task] Drupal core installer messages

Jeremy drupal-docs at drupal.org
Sat Mar 4 16:35:19 UTC 2006


Issue status update for 
http://drupal.org/node/51772
Post a follow up: 
http://drupal.org/project/comments/add/51772

 Project:      Documentation
 Version:      <none>
 Component:    Misc
 Category:     tasks
 Priority:     critical
 Assigned to:  Anonymous
 Reported by:  webchick
 Updated by:   Jeremy at kerneltrap.org
 Status:       active
 Attachment:   http://drupal.org/files/issues/messages_0.txt (2.43 KB)

Here is a smaller list of messages that should be focused on first. 
These are from the core requirements API as defined in this patch [1].
[1] http://drupal.org/node/52289




Jeremy at kerneltrap.org



Previous comments:
------------------------------------------------------------------------

Tue, 28 Feb 2006 17:12:58 +0000 : webchick

Attachment: http://drupal.org/files/issues/messages.txt (8.96 KB)

Attached is a list of error/status messages that the Drupal core
installer [2] generates. This list may be out of date by now; if so I
will post a follow-up that contains the new versions.


The idea is to make these error messages friendly and readable to
anyone who might be installing the software. The basic formula for good
error messages is:


   1. What's the problem?
   2. How do I fix the problem?
   3. How do I avoid the problem in the future? 


Here are some resources on writing good error messages I've come across
during my research:



* Error Message Guidelines [3]
* Error messages: More important to your website than you think [4]
* How to write Error Messages [5]

This is A LOT harder than it looks. :P But if you have experience
writing error messages, it would be awesome if you could lend a hand
here because we're pushing to get the installer finished ASAP. Remember
that this is the first impression people will have of Drupal, so we want
to make it as welcoming and friendly as possible.


Thank you very much.


[2] http://drupal.org/node/48732
[3] http://www.useit.com/alertbox/20010624.html
[4] http://www.marketingprofs.com/3/stoeckle1.asp
[5]
http://www.klariti.com/technical-writing/writing-error-messages.shtml






More information about the documentation mailing list