[drupal-devel] [task] Improve helpsystem and helptexts

Anisa mystavash at animecards.org
Mon Apr 18 14:48:28 UTC 2005


The long help texts are a good idea, in theory.  However, some are out 
of date, and most are very wordy.  Taking them out now gives you some 
breathing room; you're not propagating incorrect information, nor do you 
have to come up with good documentation for all core modules in a hurry.

Anisa.

stefan nagtegaal wrote:

> Issue status update for http://drupal.org/node/20760
>
> Project:      Drupal
> Version:      cvs
> Component:    base system
> Category:     tasks
> Priority:     normal
> Assigned to:  stefan nagtegaal
> Reported by:  stefan nagtegaal
> Updated by:   stefan nagtegaal
> Status:       patch
> Attachment:   http://drupal.org/files/issues/helptext-removal.diff 
> (89.03 KB)
>
> I know of you guys are falling from their chair when seeing this patch,
> but...
>
>
> The attached patch removes all long helptexts which are used by the
> help.module to display them.
> I - and i know there are more people who thinks about that the same way
> - believe that, with a good CMS these kind of very long helptexts are
> not needed. I would prefer to improve the short helptexts on top of
> every page, instead of these longer versions.
>
>
> The documentation team already started to improve these short texts, to
> reflect what people could do on a certain page..
>
>
> Another reason to delete these helptexts was that there were almost
> none of the translators who translated them. I'm not sure if that is
> because the text is too large, or the info is outdated..
>
>
> But, i think it would be better to remove these... See also the related
> thread here:
> http://lists.drupal.org/archives/drupal-docs/2005-04/msg00008.html
>
>
> By applying this patch, the help.module will be deprecated... :-)
>
>
>
>
> stefan nagtegaal
>



More information about the drupal-devel mailing list