[prev in list] [next in list] [prev in thread] [next in thread] 

List:       quanta
Subject:    Re: [Quanta] Quanta Documentation: English
From:       "Mark A. Taff" <marktaff () comcast ! net>
Date:       2007-02-02 19:18:20
Message-ID: 200702021118.20277.marktaff () comcast ! net
[Download RAW message or body]

On Friday 02 February 2007 10:17:06 Paul Lemmons wrote:
> We developers should never write end user documentation. Even when the
> audience is other developers. We all suffer from the "It is intuitively
> obvious by simple observation" syndrome.&nbsp; There is a completely
> different skill set used in writing documentation. Documentation should
> be written by those than have the skill to do it. Our role in
> documentation is to simply complain about it :)

I somewhat disagree.  I think it needs to be developers writing the docs, 
though obviously some developers have more talent for that style of writing 
than do others.  On thing I find valuable in documentation is real-world 
examples of the use of a function that go beyond just the function's basics.

That said, most quality written works are heavily edited and reworked until a 
quality result is achieved. I think for a lot of documentation the first 
draft is the *final* draft.

I am willing to help with the xhtml, php docs etc, though I am in no position 
time-wise to lead any such effort (that's why I help $upport Quanta ;-) ).

Regards,

Mark
_______________________________________________
Quanta mailing list
Quanta@mail.kde.org
https://mail.kde.org/mailman/listinfo/quanta
[prev in list] [next in list] [prev in thread] [next in thread]