ibatis-user-java mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Brandon Goodin <brandon.goo...@gmail.com>
Subject Re: [iBatis] Documentation
Date Mon, 06 Jun 2005 19:41:57 GMT
Let's not start a flame here. Please keep your criticisms constructive
and away from the edge of insulting. The bottom line is that we should
all appreciate constructive criticism. The documentation is excellent
even compared to many commercial products on the market and it can
ALWAYS be improved. If you want to help out, then you have the power
to do so. The responsibility is not solely on the committers. We
definitely want to be more user friendly. Let's all pitch in and help
it to be better.


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

I agree. You should pitch in and help make it better.


"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)."

I think you are being picky here. The real question is. Did you
understand what it was and did you grasp how to use it?


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

This would be a great comparison. But, i would consider this to be
another document. It would be more of a comparative look at straight
JDBC and iBatis.


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

Perhaps. But, do you understand the big picture now? What would help
you to understand the big picture more?


"And lastly I'd like to see the document in HTML"

HTML is a great idea.


" with a more beautiful and better layout :)"

Sorry friend, but, gimme a break. The layout is fine.


"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."

Good point. Maybe we should include the not yet documented section
into the documentation.


Finally, don't forget... you have the power to help.

Brandon

On 6/6/05, Ersin Er <ersin.er@cs.hacettepe.edu.tr> wrote:
> > 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
> >> >>
> >> >
> >>
> >>
> >
> 
>

Mime
View raw message