[drupal-docs] Task for Drupal documentation writers

Ron Mahon ron at inmrc.com
Sun Apr 3 15:37:17 UTC 2005


I like the idea of a special place for help text to live. 

As I was thinking about this I wonder if whether any one will install them?
Unless all the help text's are part of the initial distribution. Perhaps
with a flag of installed or not. 

If you follow this to it's natural conclusion you might conclude that the
help file should be role dependent. Role 1 Admin-root users: Role 2 all
others

While this discussion is focused on installation help. If I was the user
advocate I would be concerned with users help. 

Centralizing all this information would certainly make it easer to maintain.

>From my experience in Program development it is almost imposable to get a
programmer to write good documentation or help files. They simply know too
much. So a centralized location would lend it's self to third party support
of this function. 




InterNet Marketing Resource Center
A Free Super Mart of Articles, Demos, Tutorials everything you need to
Succeed on the net.
www.inmrc.com 


-----Original Message-----
From: Boris Mann [mailto:borismann at gmail.com] 
Sent: Saturday, April 02, 2005 1:57 PM
To: drupal-docs at drupal.org
Subject: Re: [drupal-docs] Task for Drupal documentation writers

On Apr 2, 2005 10:43 AM, drupal-docs at istyledthis.nl
<drupal-docs at istyledthis.nl> wrote:

> Another issue, which I did not dare to mention earlier is to 
> rewrite/review _all_ the helptexts inside drupal.. (Only the short 
> once's above every page)

This came up at the very beginning of the restart of this Docs list. I don't
want to get into it, but basically, having the help texts live inside code
makes it difficult to work with them, and there was some discussion about
getting them OUT of code and maybe included in parseable plain text-ish
format in a help/ directory.

Of course, that is definitely something for HEAD. We'll get to work on this
bunch of help texts, and go from there.

--
Boris Mann
http://www.bryght.com





More information about the drupal-docs mailing list