[drupal-docs] Planning for the Drupal 4.7 Documentation Sprint

Kieran Lal kieran at civicspacelabs.org
Wed Aug 31 16:07:34 UTC 2005


On Aug 30, 2005, at 10:36 PM, Charlie Lowe wrote:

>
>
> Kieran Lal wrote:
>
>> For 4.7 I am going to  suggest the following additions to admin  
>> help: Add pictures, add a  link to file a bug or request a feature.
>>
>
> Before you implement this, I would suggest the following:
>
> * I can imagine that there might be other areas of the  
> administration section that could use admin/help documentation  
> before adding pictures.
> Themes and blocks seem a more common need for most users. Perhaps  
> assistance with clean URL's? Etc.
OK

> * bug and feature request links might be useful for a small  
> percentage of the target audience of the admin/help text. But I  
> suspect that it might get inadvertently misused by a much larger  
> percentage of people merely seeking support or those that haven't  
> well researched whether they in fact have a bug, or whether the  
> issue has already been created. I see it potentially creating a  
> problem for the Drupal community on drupal.org. Could it better to  
> make more visible links to the support page on drupal.org instead?

Yes, abuse would be a problem.  But not getting good feature  
requests, or early bug detection is a problem as well.   Once they  
are out of Admin Help they no longer have context sensitive linking  
to report on their module.

>
>> 2) We need to empower module developers to use administration  
>> help.   They need to know where to get the documentation,  
>> guidelines on how  to convert it into code, and a commitment to  
>> get help from the  documentation team if they do write or include  
>> the documentation.  A  mass mail to all the CVS account holders  
>> seems like a potential  solution.
>>
>
> I like what you are doing with "How to understand a module so you  
> can document it." Having improved documentation writing guidlines  
> in place before the mass email is also a plus.
>
We need to run this by some Drupal Administrators to see if it's  
clear for them.

>
>> 3) We need a long term technically viable help solution that  
>> involves  automatically getting documentation.
>>
>
> +1
>
>
>> 4) We need Drupal.org to allow anonymous users to contribute pages  
>> to  the Handbook, especially administration help for modules.   
>> The  barrier to contribute to documentation is currently too high  
>> and does  not maintain a consistently high level that a closed  
>> documentation  system would normally deliver.
>>
>
> +1
>
> Are we any closer to the means to do this?

Do you want to post a request to the Drupal.org infrastructure team  
for anonymous page submission that is pre-categorized for the docs  
team review.  Then the docs team could review for moderation.

Cheers,
Kieran

> -- 
> [ drupal-docs | http://lists.drupal.org/listinfo/drupal-docs ]
>
>

-------------- next part --------------
An HTML attachment was scrubbed...
URL: http://drupal3.drupal.org/pipermail/documentation/attachments/20050831/a9bca8b7/attachment.htm


More information about the drupal-docs mailing list