Return-Path: Delivered-To: apmail-cocoon-docs-archive@www.apache.org Received: (qmail 84196 invoked from network); 14 Nov 2004 06:56:31 -0000 Received: from hermes.apache.org (HELO mail.apache.org) (209.237.227.199) by minotaur-2.apache.org with SMTP; 14 Nov 2004 06:56:31 -0000 Received: (qmail 67819 invoked by uid 500); 14 Nov 2004 06:56:31 -0000 Delivered-To: apmail-cocoon-docs-archive@cocoon.apache.org Received: (qmail 67681 invoked by uid 500); 14 Nov 2004 06:56:30 -0000 Mailing-List: contact docs-help@cocoon.apache.org; run by ezmlm Precedence: bulk list-help: list-unsubscribe: list-post: Reply-To: docs@cocoon.apache.org Delivered-To: mailing list docs@cocoon.apache.org Received: (qmail 67670 invoked by uid 99); 14 Nov 2004 06:56:30 -0000 X-ASF-Spam-Status: No, hits=-10.0 required=10.0 tests=ALL_TRUSTED,NO_REAL_NAME X-Spam-Check-By: apache.org Received: from [209.237.227.194] (HELO minotaur.apache.org) (209.237.227.194) by apache.org (qpsmtpd/0.28) with SMTP; Sat, 13 Nov 2004 22:56:25 -0800 Received: (qmail 84154 invoked from network); 14 Nov 2004 06:56:22 -0000 Received: from unknown (HELO minotaur.apache.org) (127.0.0.1) by 127.0.0.1 with SMTP; 14 Nov 2004 06:56:22 -0000 Content-Type: text/plain; charset="iso-8859-1" MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable From: docs@cocoon.apache.org To: docs@cocoon.apache.org Subject: =?iso-8859-1?q?=5BCocoon_Wiki=5D_Updated=3A__ExtremeDocumentationOverhaul?= Date: Sun, 14 Nov 2004 06:56:22 -0000 Message-ID: <20041114065622.84147.91939@minotaur.apache.org> X-Spam-Rating: 127.0.0.1 1.6.2 0/1000/N X-Virus-Checked: Checked X-Spam-Rating: minotaur-2.apache.org 1.6.2 0/1000/N Date: 2004-11-13T22:56:22 Editor: DavidLeangen Wiki: Cocoon Wiki Page: ExtremeDocumentationOverhaul URL: http://wiki.apache.org/cocoon/ExtremeDocumentationOverhaul no comment Change Log: ---------------------------------------------------------------------------= --- @@ -23,6 +23,13 @@ = * Cocoon215TOC = +=3D=3D "Project" Members =3D=3D + +The contributors to this little "project" are: + + * DavidLeangen + * + ---- = =3D Main Conent =3D @@ -35,7 +42,7 @@ = * Explain our vision of what the site should be; and * Act as the basis of a new Cocoon website; or - * Act as the basis of a new project external to Cocoon; or + * Act as the basis of a new project external to Cocoon; or even * Act as the basis for a commercial project = =3D=3D General Principles =3D=3D @@ -51,6 +58,7 @@ = * Eliminate the wiki, or have page timeouts * Be very concise, ruthlessly deleting unnecessary content + * Focus more on what the user wants to accomplish than on what Cocoon does * = =3D=3D=3D Elimination of the Wiki =3D=3D=3D @@ -61,13 +69,30 @@ = Proof of the need of this is the large number of unused pages on the wiki.= Although great effort has been made to clean up the wiki, inevitably, it w= ill again become messy after a few more months of use. = +=3D=3D Proposed Content Structure =3D=3D = -=3D=3D "Project" Members =3D=3D +This section explains the approach we will take to determine what the stru= cture of the new site should be. = -The contributors to this little "project" are: +=3D=3D=3D Fundamental Questions =3D=3D=3D + +To determine what the structure should be, we first need some way of being= able to answer these fundamental questions: + + * What type(s) of user(s) will be visiting the website? + * What is the user's goal? + * What, precisely, do we want to communicate? + + +=3D=3D=3D Task-based =3D=3D=3D + +Navigation of the site should be task-based and not content-based. What we= mean by this is that content should appear according to what the user is t= rying to achieve, rather than according to the information we want to prese= nt. This means, counter to the fundamental programming axiom of "once and o= nly once", that information may be duplicated. Note, however, that the info= rmation source need not be duplicated: only the resulting HTML. + +For example, User A is a company decision-maker with moderate technical sk= ills. She has been nagged by some of her developers to look into Cocoon, si= nce they have used it before and believe that it could help their company. = Her goal, then, is to make a first evaluation of Cocoon to evaluate the ris= k of using an open-source project from within the company. + +User B is a very experienced developer with fairly advanced skills. User B= doesn't want fluff, but wants to get right to the meat. He doesn't like pe= ople spoon feeding him information, but would rather see what's inside Coco= on and how it works and make a decision for himself. + +User C, however, is fairly new to programming, or at least Java programmin= g. His job is to build a corporate website for a small company of 50 people= . He has used PHP, but is frustrated with its limitations. Hearing about wh= at Cocoon has to offer, he wants to give it a try. = - * DavidLeangen - * = +Each of these types of users have not only very different goals, but diffe= rent skill sets. What they want from the site is very different. Using the = "once and only once" approach, it is simply not possible (except using some= business logic in a dynamic site, which is not what we're proposing here). = =3D=3D =3D=3D