Architecture / design docs?

[easyproglife <ea...@gmail.com>]

Xavier,

Do you have some architectural and/or design documentations of Ivy?

Current Ivy documentation at Jayasoft contains a few docs and I wonder if
you have some other internal docs.

I think they also can find their place to the wiki and be publicly
available.

Do you agree?

Re: Architecture / design docs?

[easyproglife <ea...@gmail.com>]

Yes. It makes sense.

The most important thing IMO is to have design docs / UMLs. I less care
about the actual design at the moment.

After the design docs would be publicly available, it would be much easier
to discuss changes and enhancements according to the requirements (that
would also be public).


On 11/15/06, Xavier Hanin <xa...@gmail.com> wrote:
>
> On 11/15/06, easyproglife <ea...@gmail.com> wrote:
> >
> > Xavier,
> >
> > Do you have some architectural and/or design documentations of Ivy?
>
>
> I'm afraid not. The only doc about ivy internals is a small description of
> the algorithm used to do conflict resolution:
> http://svn.jayasoft.org/ivy/trunk/doc/conflict-solving-algo.html
>
> Current Ivy documentation at Jayasoft contains a few docs and I wonder if
> > you have some other internal docs.
>
>
> Nope, nothing internal
>
> I think they also can find their place to the wiki and be publicly
> > available.
> >
> > Do you agree?
>
>
> Sure. I plan to write some design documentation, but I think I'll write
> them
> after the refactorings I'll do for next version (let's call it 1.5).
> Indeed
> I'll try to clean up some code, move some classes and packages, and split
> some things (like the Ivy class which is too big). I'll write about that
> before doing the refactoring, thus it will be a good start for a design
> documentation of the slightly refactored code that will made the
> 1.5version. Does it make sense for you?
>
> Xavier
>
>

Re: Architecture / design docs?

[Xavier Hanin <xa...@gmail.com>]

On 11/15/06, easyproglife <ea...@gmail.com> wrote:
>
> Xavier,
>
> Do you have some architectural and/or design documentations of Ivy?


I'm afraid not. The only doc about ivy internals is a small description of
the algorithm used to do conflict resolution:
http://svn.jayasoft.org/ivy/trunk/doc/conflict-solving-algo.html

Current Ivy documentation at Jayasoft contains a few docs and I wonder if
> you have some other internal docs.


Nope, nothing internal

I think they also can find their place to the wiki and be publicly
> available.
>
> Do you agree?


Sure. I plan to write some design documentation, but I think I'll write them
after the refactorings I'll do for next version (let's call it 1.5). Indeed
I'll try to clean up some code, move some classes and packages, and split
some things (like the Ivy class which is too big). I'll write about that
before doing the refactoring, thus it will be a good start for a design
documentation of the slightly refactored code that will made the
1.5version. Does it make sense for you?

Xavier