[documentation] D7 core docs sprint #1

[Addison Berry]

Hi ilyse,

Actually working on developer documentation is something new and  
rarely done by our documentation team or discussed in this list. :-)  
We have a ton of end user documentation work that needs to be done as  
well. This is just one particular initiative we are working on at the  
moment. The Docs team works on *all* documentation for Drupal and so  
we have a number of projects running at the same time in different  
areas. If you would rather work on end user docs, we currently need  
help with the upgrade and installation guides. Here are the issues  
where these are being discussed:
http://drupal.org/node/536854
http://drupal.org/node/538054

In particular we still really need someone to step up and start the  
review/revision process for the Installation guide and find out if  
there are improvements to be made and what changes are needed for  
installing Drupal 7. Of course, you can also just dive in to begin  
editing just about most anywhere in the handbooks.

I also want to point out that core docs is *not* just developer  
documentation, but also the help text that is displayed throughout a  
Drupal installation, so you don't have to be a developer to help with  
core docs.

Welcome aboard, we'll be able to find plenty for you to work on. ;-)

- Addi



On Aug 4, 2009, at 4:08 PM, adept digital evolution wrote:

> On 08-04-2009 10:53 AM, Jennifer Hodgdon wrote:
>> adept digital evolution wrote:
>>> 2. When you say "core doc" I presume that means programmer's  
>>> documentation and not end-users?
>>
>> Yes, we are having "sprints" to get the developer-facing  
>> documentation, which is mostly on api.drupal.org and mostly  
>> embedded in core Drupal PHP files, fixed up.
>>
>> Links in the announcement (http://groups.drupal.org/node/24913)  
>> will take you to the issue queues for the issues we will be  
>> focusing on, if you're interested.
>>
>> However, if you would like to work on other documentation issues  
>> and show up on the IRC channel, I'm sure no one will object. :)
>>
>> Regards,
>>   Jennifer
>>
>
> I think I have joined this project by mistake. I have little  
> experience with php, and zero experience programming with Drupal.  
> Therefore anything written for the developers would be beyond my  
> capabilities to help with. In my consulting & biz analyst career  
> (and some lightweight 4GL "programming") I have had plenty of  
> opportunity to write help docs for end-users and in general have  
> strong document-architecture and writing skills ....
>
> had mistaken this whole "Documentation" effort to mean improved docs  
> for users. From the standpoint of a Drupal _user_, even one who is  
> quite tech savvy, the docs need a lot of work and I was hoping to  
> pitch in.
>
> Is that part of this, or should I just politely go away? :-)
>
> ilyse
> --
> Pending work: http://drupal.org/project/issues/documentation/
> List archives: http://lists.drupal.org/pipermail/documentation/