Cris, this is looking SWEET so far! I'm in favor of a conventions
section/etc, but if people add good docs to the wiki that are slightly
askew in formatting, I don't have a problem with that, either. Good
docs are better than no docs. And being in a wiki format, can be easily
cleaned up by a WikiGnome
(http://en.wikipedia.org/wiki/Wikipedia:WikiGnome).
-----Original Message-----
From: Cris Daniluk [mailto:cris.danilu..mail.com]
Sent: Wednesday, February 08, 2006 9:31 PM
To: cayenne-deve..bjectstyle.org
Subject: Re: New Doc space
I finished everything but the ant tasks. I couldn't take anymore for one
day :)
The tables are a bitch, but everything else went pretty smooth. Only
took a few hours. We temporarily lost the link to the javadocs... I
think a flexible approach like a custom macro is worth doing here, so
that we don't have to manually fix a bajillion links every release.
I resisted the temptation to clean up any mistakes I found (except the
occasional mispelling) so that we can have a clean basis for
comparison when we do make changes, via page history.
I noticed a lot of inconsistencies (when we used monospaced vs italics
vs bold vs vs vs), probably because of all the hands that have been in
the docs. Now that we have it in an open format, that inconsistency
will probably only grow. I think it might be worthwhile to adopt some
standards for the documentation going forward... nothing fancy. Maybe
something along the lines of the "Conventions" section found at the
beginning of most tech books.
Cris
On 2/8/06, Kevin Menard <kmenar..ervprise.com> wrote:
> On 2/8/06 4:02 PM, "Cris Daniluk" <cris.danilu..mail.com> wrote:
>
> > It seems like its going pretty well, so I don't think I'll need any
> > assistance.. though the modeler guide needs ported too :)
>
> Well, that's good to hear. Guess I'll tackle the modeler guide then.
>
> --
> Kevin
>
>
>
This archive was generated by hypermail 2.0.0 : Thu Feb 09 2006 - 09:29:57 EST