[drupal-docs] Regarding the drupal help documentation

[Dan Robinson]

ok - so what I'm looking for here is an editor - I wrote a bunch of 
stuff last night and now it needs editing.  The only thing is that we 
better make sure that the editor is really speaking for the whole 
community - otherwise we'll all wind up being disapointed.  I put my 
stuff up in the Wiki and everyone is empowered to go over there and hack 
away - if you don't want to change my stuff then just add some content 
of your own.

>  just to chime in here before we set a rule. length depends on what 
> you are writing about. while i don't know if anyone said this or not, 
> we shouldn't disqualify a document because it is too long or too 
> short. write everything you feel you should write and then edit it. or 
> give it to an editor to decide. obviously you may need to add more or 
> remove more until you get it as close to what needs to be said.
>
> as for putting the help documentation into the modules. length in this 
> situation *is* an issue. in that case we just summarize what we can 
> and then if it needs more link to the documentation (or handbook).
>
> i think a very valuable lesson is what charlie pointed out, in his 
> comment on Krugs comment,
>
>"The main thing you need to know about instructions is that no one is
>going to read them -- at least not until after repeated attempts at
>/muddling through/ have failed."
>
> we are going to find some usuability issues as we write this 
> documentation up. we are going to find things that need to change or 
> are poorly implemented. what do we do? can we make a list of suggested 
> usability changes?
>
> best regards,
> judah
>
> Kieran Lal wrote:
>
>>Assume that we aren't going to get documentation development and we  
>>are going to be stuck with the existing help module.
>>
>>The docs team wants the docs to be online.  We don't want detailed  
>>docs inside the code which is what is happening if it is there at all.
>>
>>The intention is move 2 and 3 to the handbooks.
>>
>>  
>>
>
>-- 
>re·gard
> 1. To look at attentively; observe closely.
> 2. To look upon or consider in a particular way.
> 3. To hold in esteem or respect: She regards her teachers highly.
> 4. To relate or refer to; concern: This item regards their liability. 
>
>best
> 1. Surpassing all others in excellence, achievement, or quality; most excellent: the best performer; the best grade of ore.
> 2. Most satisfactory, suitable, or useful; most desirable: the best solution; the best time for planting.
> 3. Greatest; most: He spoke for the best part of an hour.
> 4. Most highly skilled: the best doctor in town.
>
>------------------------------------------------------------------------
>
>No virus found in this outgoing message.
>Checked by AVG Anti-Virus.
>Version: 7.0.308 / Virus Database: 266.11.6 - Release Date: 5/6/2005
>  
>