[documentation] Improving help pages in D7

[Jennifer Hodgdon]

Thanks! First we need a standard...

    --Jennifer

Peter Dowling wrote:
> I had volunteered on that issue I believe.
> 
> Yes, I'd be happy to take two or three at least.
> 
> - Peter (winston)
> 
> On Fri, 2009-11-13 at 08:04 -0800, Jennifer Hodgdon wrote:
>> Hello Drupal Docsters,
>>
>> A couple of months back, arianek noticed some issues in the help text 
>> for "node" in Drupal 7, and in conjunction with some other folks and 
>> input and such, created a much better version of the help text, with 
>> headers, formatting, etc. Issue: http://drupal.org/node/537828
>>
>> The patch was not committed, largely because webchick raised an 
>> objection that this would make the help text for the node module quite 
>> different from the (rather lame) other help text in Drupal. She 
>> basically said she would only commit the improved help page if the doc 
>> team committed to improving all the other core Drupal help texts in 
>> the same manner. i.e. all or nothing!
>>
>> The deadline for UI text changes is December 1st, which is just 17 
>> days away (and several days of that are holidays here in the US), if 
>> we wanted to fix up all the help files. There are about 40 core 
>> modules that would need this fixup, and one (node) has been done.
>>
>> So, here are the questions:
>>
>> a) Can we come to consensus quickly on a new standard for help docs, 
>> and document it somewhere in the Handbook? [Note: I think this doc 
>> belongs under: http://drupal.org/node/360052 (Standards, security, and 
>> best practices, in the development guide).]
>>
>> b) Can we come up with enough people to divide and conquer the 40 core 
>> modules, and rewrite all of their help text to conform to the new 
>> standard, and get the patch reviewed, all by December 1st?
>>
>> I'll be on IRC #drupal-doc today as much as I can, if people want to 
>> discuss there... or reply to this message.
>>
>> Regards,
>>     Jennifer
>>
> 
> --
> Pending work: http://drupal.org/project/issues/documentation/
> List archives: http://lists.drupal.org/pipermail/documentation/
> 
> 
> 


-- 
Jennifer Hodgdon * Poplar ProductivityWare
www.poplarware.com
Drupal, WordPress, and custom Web programming