[drupal-docs] Why we decided to add reference
to the drupal handbook in administration help
Charlie Lowe
cel4145 at cyberdash.com
Thu Sep 29 14:52:39 UTC 2005
Gabor Hojtsy wrote:
>
>
> It is not just keeping the clients in the dark, but if you modify some
> inner working substantially (like I forward ported the 4.4 tracker view
> to one of my 4.6 sites, since we were accustomed to that view, and were
> interested in recent comments). Now with changes like this, the admin
> help links point to some documentation which is not relevant to that
> exact module I have on the site. Sure, one who modifes Drupal so
> heavily, can easily remove this part of the help text either by doing a
> "translation" or by editing the code.
Wouldn't this be the very small exception rather than the rule for most
Drupal sites on the web? And if we use this case as a guideline for
writing docs to go in the admin/help, should't we just leave out
admin/help all together since potentially the onsite documentation page
for a module could be invalid?
Besides, IMHO, from a usability perspective, if a developer does that
kind of custom work to a site, I would think that a best practice would
be for them to also do customization to the documentation in the
admin/help explaining those changes so that their users understand the
non-standard functionality for their Drupal version. This is regardless
of whether or not that link exists. So in a small way, perhaps this is
good because it would encourage developers to provide better help
documentation for their clients :)
More information about the drupal-docs
mailing list