ToC draft for documentations

An online version of the first steps in refactoring the lenya documentation can be found here. One aim is to use as many images as possible (and senseful) to explain how everything works. That helps to get the big picture of lenya and pix are international ;-)! I used the SoC four major concern areas to structure the docu.

The above link do not show the structure of the docu (so far), so I thought about something like the following:

Agenda

  1. introduction
  2. OverviewCMS

  3. background/history of Lenya
  4. SoC

  5. concern guides
  6. dev (admin) guide -> logic (setting up and developing the environment)

    1. Installation of 1.2 (src/bin)

    2. NewPublicationHowTo

    3. DeployPublicationHowTo

    4. AddingCustomDocType

    5. AccessControl

    6. creating contracts (e.g. <dynamic:today/>)

  7. management guide (manage the site)
    1. GuideUserManagement

      1. create new user
    2. Control content life cycle stages
    3. Workflow

      1. create new workflow
  8. Building and Editing Sites with Lenya designer guide (changing the view and overall design)

This chapter / book / section assumes that an administrator has set up Lenya for you and will take care of administrative tasks that cannot be accomplished through the CMS screens (yet). Therefore it will entirely focus on your bread and butter business: Creating and maintaining a great experience for the visitor of your site.

  1. The Architect, the Designer and the Editor (ArchitectDesignerEditor)

  2. Change look and feel of overall site (ApplicationLookandFeelHowto)

  3. content guide (for content editor) (GuideContentEditor)

    1. writing text
    2. formating text
  4. adding pictures (PicturesHowto)

  5. using contracts (e.g. <dynamic:today/>)

...

Please, feel free to add some new points to the exiting agenda.

What do YOU want to know when reading the documentation? Do you have some pix for the docu that explain some components? Do you have some existing lenya docu that you may have written for your company, client, ...?

Everything will be highly welcome and we promise you that you can find your work in the documentation!

Attachment: WPS+FAQ.doc

ProposalDocumentation (last edited 2009-09-20 23:27:18 by localhost)