|
From: | Paul Scott |
Subject: | Re: improving docs (was: Break_Align_Order-3) |
Date: | Fri, 14 Mar 2003 23:48:21 -0700 |
User-agent: | Mozilla/5.0 (X11; U; Linux i586; en-US; rv:1.2.1) Gecko/20030311 Debian/1.2.1-10 |
Graham Percival wrote:
I can certainly do some of that. My next concern/question would be concerning versions. I use whatever is packaged for Debian unstable - currently 1.6.6. Is there much point improving that documentation when the development is done on a later version? I see the online manual is actually 1.6.0.On Fri, 14 Mar 2003 17:00:18 -0700 Paul Scott <address@hidden> wrote:Han-Wen Nienhuys wrote:How about some diagrams showing the relationships between the various dimensions and what they apply to?Please make some! :-)I wish I knew enough about these to do that.You don't really need to know a lot to improve docs (this isn't just directed at you, Paul; as Han-Wen says, many people have asked for better documentation). If you (or anybody else) is a good proofreader, then simply proofread the documents -- that's what I did until I agreed to finish my cello suite before I graduate (in a few weeks). While you're proofreading, you can add in a bit of rephrasing, extra explanations, or better examples.
When you're having trouble understanding something, make a note of it. Once you _do_ understand it, rewrite or create a new piece ofdocumentation that makes it easier to understand.
I will see what I can do. Thanks, Paul
[Prev in Thread] | Current Thread | [Next in Thread] |