Return-Path: Delivered-To: apmail-incubator-jspwiki-dev-archive@locus.apache.org Received: (qmail 91868 invoked from network); 8 May 2008 19:44:13 -0000 Received: from hermes.apache.org (HELO mail.apache.org) (140.211.11.2) by minotaur.apache.org with SMTP; 8 May 2008 19:44:13 -0000 Received: (qmail 97128 invoked by uid 500); 8 May 2008 19:44:14 -0000 Delivered-To: apmail-incubator-jspwiki-dev-archive@incubator.apache.org Received: (qmail 97117 invoked by uid 500); 8 May 2008 19:44:14 -0000 Mailing-List: contact jspwiki-dev-help@incubator.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: jspwiki-dev@incubator.apache.org Delivered-To: mailing list jspwiki-dev@incubator.apache.org Received: (qmail 97106 invoked by uid 99); 8 May 2008 19:44:14 -0000 Received: from nike.apache.org (HELO nike.apache.org) (192.87.106.230) by apache.org (qpsmtpd/0.29) with ESMTP; Thu, 08 May 2008 12:44:14 -0700 X-ASF-Spam-Status: No, hits=-0.0 required=10.0 tests=SPF_PASS X-Spam-Check-By: apache.org Received-SPF: pass (nike.apache.org: domain of Janne.Jalkanen@ecyrd.com designates 193.64.5.122 as permitted sender) Received: from [193.64.5.122] (HELO mail.ecyrd.com) (193.64.5.122) by apache.org (qpsmtpd/0.29) with ESMTP; Thu, 08 May 2008 19:43:21 +0000 Received: from [192.168.0.14] (cs181005170.pp.htv.fi [82.181.5.170]) (using TLSv1 with cipher AES128-SHA (128/128 bits)) (No client certificate requested) by mail.ecyrd.com (Postfix) with ESMTP id 59C0648200 for ; Thu, 8 May 2008 22:43:42 +0300 (EEST) In-Reply-To: <176632746.20080508193924@holeczek.de> References: <1210113506.29334.869.camel@netframe> <8F4CF652-FE32-44A9-8A10-45E805633CFE@mac.com> <1210125116.29334.884.camel@netframe> <43C8A522-7D13-4DEB-B9B5-0C9A4335D75C@mac.com> <1210168961.29856.25.camel@netframe> <1210176068.29856.78.camel@netframe> <9E1E32DC-9C3A-49DD-9C37-470E0E1353AB@ecyrd.com> <176632746.20080508193924@holeczek.de> Mime-Version: 1.0 (Apple Message framework v753) X-Priority: 3 (Normal) Content-Type: text/plain; charset=US-ASCII; delsp=yes; format=flowed Message-Id: Content-Transfer-Encoding: 7bit From: Janne Jalkanen Subject: Re: Higher level project documentation, Was: Re: Other 2.6.2 changes Date: Thu, 8 May 2008 22:43:22 +0300 To: jspwiki-dev@incubator.apache.org X-Mailer: Apple Mail (2.753) X-Virus-Checked: Checked by ClamAV on apache.org > Aren't there any tools which could analyze a code base and generate a > project map / graphical class overview with dependencies a.s.o.? Yes, there are, but these are in general useless, since they don't really describe how the software works. Process diagrams and tutorials are far more useful. > Well I think, the big picture documentation can only be done by people > who at least have enough overview on the project and its history. True, but we still need someone who is willing to take overall responsibility of the documentation and find the bits that need to be documented. Also clean it up once someone writes some documentation, and makes sure it is organized well and is up to date. I'm happy to contribute when someone says that "this bit here, that needs contribution from YOU since you understand it", but I can't take on the entire project management of the documentation, too... /Janne