cocoon-users mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Tony Collen <tcol...@neuagency.com>
Subject Re: proposal: "The Newbies Competence Center"
Date Mon, 27 Jan 2003 19:03:02 GMT
On Mon, 27 Jan 2003, SAXESS - Hussayn Dabbous wrote:

<snip/>

> o There was an idea to redesign the cocoon documentation entry page
>    and provide chapters like:
>
>    1) First steps
>    2) User's Manual
>    3) User's Reference
>    4) Architecture
>    5) Developer's Guide

This is good. HOWEVER, occasionally the line between "user" and
"developer" gets blurred, especially when a user realizes they need to
develop a custom component.

All too often, I've gone to the developer section looking for information
that was actually in the user guide, and vice versa.

One thing I'd like to see, at least for the "production" docs, is to have
the API Javadocs up front and center.

I may have mentioned this one last time the issue of docs came up, but
here's another thing that confused me:

(Taken from xml.apache.org/cocoon/):

Documentation
  Introduction
  Installing
  Overview
  User Guide
  Dev Guide
  Tutorials
  FAQs
  How-Tos
  Performance
  Snippets
  ToC

Ok, Introduction and Installing are good, and Overview I can understand.
Perhaps these are a little out of order.  Now the problem is, where do I
go to in order to find out how to strip out my sitemap?  There's a User
guide, Tutorials, FAQs, and How-to's, which all sort of could be the same
thing.. especially "Tutorials" and "How-tos".  Snippets could also be
considered how-to, but also probably tutorial.  The same goes for the
"performance" section.

Basically, what I see needs to be done, is we need all of this info
consolidated into one place.

Remember, the docs are for the users, and unfortunately, the developers
might have a different idea about how the information "should" be
categorized.    Or maybe our problem is making the distinction between
"users" and "developers" ...  I would guess that eventually, most users
become developers, so then, it's just a matter of "beginning user" vs.
"power user", and so on.



Tony

--
Cocoon: Internet Glue (A Cocoon Weblog)
http://manero.org/weblog/



---------------------------------------------------------------------
Please check that your question  has not already been answered in the
FAQ before posting.     <http://xml.apache.org/cocoon/faq/index.html>

To unsubscribe, e-mail:     <cocoon-users-unsubscribe@xml.apache.org>
For additional commands, e-mail:   <cocoon-users-help@xml.apache.org>


Mime
View raw message