Idiotmatic D

Craig Dillabaugh cdillaba at cg.scs.carleton.ca
Fri Feb 7 05:55:47 PST 2014


On Friday, 7 February 2014 at 01:40:38 UTC, Brian Schott wrote:
> On Friday, 7 February 2014 at 00:38:21 UTC, Mike wrote:
>> IMHO the best people to get it done are the ones who implement 
>> or change the feature.  The job isn't finished until they've 
>> done so.
>>
>> Mike
>
> Adding to this point: The people who need to look at the docs 
> are almost by definition not qualified to write them.

That is true to an extent, but I also think that in terms of 
writing documentation that is helpful to beginners, it is often 
useful to have it written by someone who is, or recently was, a 
beginner themselves. Often these individuals have a fresh memory 
of what concepts they struggled with, and what was vague in the 
documents.

It is sort of like how you can "wtre a snetecne in soem langauge 
and a procfient readr can stlil raed it, even if you psell all 
the wrods wrnog", because they almost sub-conciously correct all 
the mistakes. The same likely holds for documentation, where the 
expert can read the documentation and without even thinking fill 
in all the blanks without realizing what the blanks are.

In this respect I think even people new to the language can make 
a useful contribution.




More information about the Digitalmars-d mailing list