[documentation] Documentation Team

pyutaros at idkd.net pyutaros at idkd.net
Fri Mar 30 13:47:43 UTC 2007


> This is cryptic?
> http://drupal.org/node/23367
>

No.  That's just SLIGHTLY vague.  Let's not get testy here.  Here's how I
see it.  Documentation has to be BLATANTLY obvious for it to be really
effective.  Good documentation should make my grandmother feel comfortable
using Drupal.  That's why I'm offering to help.  I see tons of places it
could be improved and I will gladly spend my time pouring through existing
pages to help make it happen.

Currently, when a user comes to drupal.org, it is quite possible they may
never know that they have the capacity to contribute documentation.  Most
people don't even get that they need to post module support issues under
the modules issue page.  If we're lucky, stuff winds up in the support
forum instead of general discussion.  So maybe cryptic or vague is too
strong.  It's not blatantly obvious.

I don't know how many folks here are Douglas Adams fans, but right now we
have documentation that's posted clearly in a basement where the lights
and stairs are out behind a door that says beware of leopard.  I know
there is a "contribute" link.  That brings you to this snippet.

>Documentation
>Whether you're interested in providing fine-grained API documentation,
>writing step-by-step tutorials for the handbook, or producing multimedia
>screencasts to show people how Drupal works, you can help improve
>Drupal's documentation, and provide a valuable resource to the
community.

>Find out how to help with documentation.

You click the link.  Now it's talking about mailing lists, issues in the
documentation project, become a doc team maintainer, helpful links.  If
you manage to land on the page that Steven refers to above, then you MIGHT
get the fact that you are then supposed to go to the project issues page
for documentation and submit an issue where you are supposed to request
the doc maintainer role.  (Which I just did.)

Is that all really necessary though?  Is the aim to discourage, or to make
joining as easy as possible.  Well, it doesn't matter really.  I submitted
an issue and this probably isn't the right forum anyways.  So once
again...

>If it seems vague/cryptic then I think step one is to rewrite the
>vague/cryptic parts so that they make sense.  Once you're done with
>that, you'll be ready to join the team.
>
>Greg

What's the process for me to submit my suggestions / changes / revisions? 
Do I write up a word document first?  (sic)  I can see that there's a
document on how to contribute to documentation, so I will begin pouring
over that to familiarize myself with the processes.  I think obviously my
first task is going to be submission suggestions on the "how to become a
handbook contributor documentation".

>> -----Original Message-----
>> From: documentation-bounces at drupal.org [mailto:documentation-
>> bounces at drupal.org] On Behalf Of pyutaros at idkd.net
>> Sent: Thursday, March 29, 2007 6:38 PM
>> To: documentation at drupal.org
>> Subject: [documentation] Documentation Team
>>
>> Hello everyone.  So how do I join the Documentation Team and begin
>> cleaning up mounds of pages that are either out of date, need more
>> clarification, or need consolidation?  Sorry for being dense, but I
>> found
>> the existing documentation on how to join the documentation team to be
>> slightly vague and cryptic.
>> Thanks,
>> Jonathan
>>
>> --
>> Pending work: http://drupal.org/project/issues/documentation/
>> List archives: http://lists.drupal.org/pipermail/documentation/
>
>
> --
> Pending work: http://drupal.org/project/issues/documentation/
> List archives: http://lists.drupal.org/pipermail/documentation/
>




More information about the documentation mailing list