Mailing-List: contact ibatis-user-java-help@incubator.apache.org; run by ezmlm
Precedence: bulk
Reply-To: ibatis-user-java@incubator.apache.org
Received-SPF: pass (hermes.apache.org: local policy)
Message-ID: <2681.81.214.146.199.1118085837.squirrel@www.cs.hacettepe.edu.tr>
In-Reply-To: <e3c4878d0506061201507976f4@mail.gmail.com>
References: 
    <1477.81.214.146.199.1118080759.squirrel@www.cs.hacettepe.edu.tr><2fe5ef5b0506061142374ea5b2@mail.gmail.com><2001.81.214.146.199.1118083790.squirrel@www.cs.hacettepe.edu.tr>
    <e3c4878d0506061201507976f4@mail.gmail.com>
Date: Mon, 6 Jun 2005 22:23:57 +0300 (EEST)
Subject: Re: [iBatis] Documentation
From: "Ersin Er" <ersin.er@cs.hacettepe.edu.tr>
To: ibatis-user-java@incubator.apache.org
User-Agent: SquirrelMail/1.4.3a-9.EL4
MIME-Version: 1.0
Content-Type: text/plain;charset=iso-8859-1
Content-Transfer-Encoding: 8bit
Importance: Normal

> Whoooooaaaaaaoooo:
>
> One of the great attributes of iBatis is its documentation.
>
> I have seen commercial products that do not measure to the well organized
> and detailed documentation ofiBatis an Open Source based product.

I appreciate the current condition of the documentation as being a open
source project, but it should be better.

> For the authors and for us users of iBatis, it will be beneficial for you
> to
> clarify:
>
>    1. Organization of the material. How is it that you perceive the
>    available material as disorganized?

For example, on page 27, a Category - Product example is given for Complex
Collection Properties. On the next page the iBatis solution is given with
a different example. I'd like to see the same example enhanced (ofcourse
the primary example could be a more complex one to demonstrate the
benefit).

For example, I'd like to see a more pure JDBC Compared approach (at least
a few examples) for showing the iBatis value.

I cannot catch the big picture really (may be because of not being a
native English speaker).

And lastly I'd like to see the document in HTML with a more beautiful and
better layout :)

>    2. Undocumented features. What features are you trying to use for
>    which information is unavailable.

http://opensource.atlassian.com/confluence/oss/display/IBATIS/Not+Yet+Documented

and 2.1.0 features. Lastly as being an Apache Project, I think, the
documentation needs at least some informational changes to reflect the
current state.

Thanks.

--
Ersin

> jfz.
>
> On 6/6/05, Ersin Er <ersin.er@cs.hacettepe.edu.tr> wrote:
>>
>> > is there a reason for a major update to the ibatis sql mapper
>> > documentation?
>>
>> I think yes. It seems to be unorganized and there are undocumented
>> features, to me..
>>
>> --
>> Ersin
>>
>>
>> > On 6/6/05, Ersin Er <ersin.er@cs.hacettepe.edu.tr> wrote:
>> >> Hi,
>> >>
>> >> Is there any plan for a major update for iBatis SQL Mapper
>> >> documentation?
>> >>
>> >> Thanks.
>> >>
>> >> --
>> >> Ersin Er
>> >>
>> >
>>
>>
>