[drupal-docs] Task for Drupal documentation writers

[mystavash at animecards.org]

What's all this fun stuff going on while I am on vacation?  ;)

Certainly would be very delighted to stick my nose in this too!  As has already
been suggested, we should focus on the items that already there. If someone is
willing to make the patches for it, I don't know that the fact help is in the
code is a problem...  it just means more cooperation is required!  (you know...
cooperation? ;)

I have only one thing to add...  If we want to standardize all the help texts
for core modules, we should think about what the standard should be (sorta like
the stylesheets I posted about earlier).  

Stefan has a good start with his expectations below, but I remember reading
sometime on the devel list someone objected to the use of the phrase 'click
on...' so I wonder...  there seem to be informal writing guides people enforce
inconsistantly.  If we make one style guide for each type of text, things can
only get better, and at least we're not propagating the kinds of errors we want
to prevent.

Anisa.
In Kyoto. ;)

Quoting drupal-docs at istyledthis.nl:

> > On Apr 2, 2005 12:50 AM, Stefan Nagtegaal <Drupal-Docs at istyledthis.nl>
> > wrote:
> >> Once again, if people write some documentation for these pages, I'll
> >> make a patch if they are not able todo so.. But imo this _reall_ should
> >> get into 4.6...
> >
> > That's great, Stefan. Sounds like a great project. Do we (not you
> > Stefan, I mean anyone) have a 4.6 install somewhere that we can get
> > admin access to?
> If this is needed I am willing to set my own domain up for this..
> 
> 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)
> 
> They are very inconsistent and give at some pages not even a good help. It
> would be very nice if there were some guidelines for the documentation,
> but unfortunatly they are not (yet?) available..
> 
> What I expect from an helptext is:
> - A short summary of what is displayed on the viewed page;
> - A nice list of all the options/operations that could be clicked on and
> what the result of that would be;
> 
> I think this is enough for the short-documentation above the pages. the
> more extended helppages need also a rewrite, but we can postpone that till
> HEAD is open for development again imo..
> 
> Any people willing to give a hand on this?? If needed, I'll make patches
> if you guys can't do this yourself..
> Unfortunatly my English isn't good enough to help write these docs myself,
> but maybe I can help getting this in by giving my 0,02 cents...
> 
> 
> Hope to hear from you...
> 
> 
> 
> 
> 
> Stefan
> -- 
> [ drupal-docs | http://lists.drupal.org/listinfo/drupal-docs ]
>