Document Information

Last modified:
2007/06/06 15:56 by wpbasti

Qooxdoo Manual: Site Map

Page Status: draft

This is a site map for a proposed structure of the qooxdoo manual. Important for now is the basic structure, outlined by the section headings and their sub-items. To flesh things out a bit more, I have included links to existing pages in the appropriate places, but only from the main documentation page and one level deeper. So there might be a fair amount of further documents existing that could be integrated. But for now, the links shall only reveal the general direction of the sections.

Important for any site map is the decision for a single aspect as the organizing principle. Each documentation page or information item can be classified along multiple aspects or dimensions (as with all real-world things). E.g. a document such as the Using the Skeletons document has a contents aspect (”building a qooxdoo application” as opposed to “class system” or “compiler internals”), a style aspect (its step-by-step, taking-the-user-by-the-hand attitude would qualify for “tutorial” or “how-to”, in contrast to “background information”, “founding principles”, or “todo-list”), an audience aspect concerning the addressed audience (”newbie”, “experienced”, “advanced”, “user”, “developer”), a location aspect (”local” vs. “external”), or a completeness or relational aspect, which concerns its relation to other documents (”self-contained”, “overview”, “link-page”, “annotation” etc.). Other aspects often seen in classifying information is along the lines of their format (.doc, .html, .pdf), author (see e.g. CPAN) or date. It’s easy to see that some aspects lend themselves better as an organizing principle than others (Have you ever searched for a document where the documents where organized along their file extension?! - :-/)

For a site map that should help the user find things through systematics, mixing the aspects by which items are organized is a killer. I decided to organize this site map along the contents or concept aspect, i.e. all information items are classified along the question “Which conceptual part of qooxdoo do they mainly belong to?”. Of course, since all things have multiple aspects, deciding for one of them has some trade-offs. But usually users pick up the chosen aspect dimension easily, and are then better able to find things. Also, even with a single dimension it is sometimes hard to classify a specific document, since documents can jump and mix all around (although they shouldn’t ;-)). But it’s still beneficial to weigh the document’s contents in this regard as good as possible and then make an informed decision. There is no taxonomy that is pure and without ambiguities, but it’s worth to try for the best.

Besides this general index/site map, there might be other documention pages that reside outside it. But those pages should never contain additional information, but serve only as additional navigational aids, i.e. topic-related link pages for e.g. a release, news, whats-new-and-hot hints, pre-factored popular searches and such. Nothing that can be found through these additional pages should be missing in this site map, otherwise its main purpose becomes void. New documents should always be linked from here first, and only then optionally from a topic-related page outside the site map. The qooxdoo manual site map should be the one-stop place, from where all information about qooxdoo can be accessed, reliable, exhaustive and systematic.

Manual Site Map

Quick Start Guide

  • qooxdoo for the Impatient
  • qooxdoo online
  • Get the Quick Start Package
  • Next Steps

Introduction

Installation & Setup

  • Available Packages
  • Quick Start
    • Requirements
    • Download
    • Install
  • Build
    • Requirements
    • Download
    • Install
  • SDK
    • Requirements
    • Download
    • Install
  • SVN
    • Requirements
    • Download
    • Install

The Class System

API Overview

Creating qooxdoo Applications

qooxdoo Hacks

Documentation Writer Manual

Project Maintenance

Release Notes

Information

Last modified:
2007/06/06 15:56 by wpbasti

Account

Not logged in

 
 

Job Offers

To further improve qooxdoo we are seeking javascript developers. Read more...

Rich Ajax Platform (RAP)

RAP uses qooxdoo, Java and the Eclipse development model to build rich web applications. Read more...

qooxdoo Web Toolkit (QWT)

Similar to GWT this framework allows to create impressive qooxdoo applications just using Java. Read more...

Pustefix

Pustefix is a MVC-based web application framework using Java and XML/XSLT. Read more...

 
SourceForge.net Logo

Bad Behavior has blocked 0 potential spam attempts in the last 7 days.