RE: [Springframework-developer] Dcoumentation

[Alef A. \(JTeam\) <al...@jt...>]

> One approach is obviously the Maven or Forrest one, where it 
> puts out a site in a consistent format. This is pretty easy to use
obviously. On 
> the other hand, what I _really_ appreciate about the coWiki approach 
> used by Hibernate to run their site is that it  encourages 
> end-users to 
> document their own tips and tricks, and makes it much easier for 
> _anybody_ to add spontaneous documentation, which can 
> possibly later be 
> incorporated into the real docs.

I definitely like the Hibernate approach. Keep the website small, easily
accesible and very consistent documentation because it's maintained by
the developers and put in a consistent format plus a lot of user
communication via the Wiki. But that's just me...

<darren>So would all future documentation be 
created and maintained as source in DocBook XML if it's agreed to adopt
it?
</darren>

I like the two-step approach, let users contribute in the form of a
userfriendly Wiki, then merge it in into the DocBook documentation...
Might generate some more work for the developers but keeps things _very_
consistent...

> So if Maven/Forest is used to produce the site, I think there should 
> still be a friendly/usable wiki (like coWiki, as opposed to 
> most Wikis, 
> which scare people off), for supplemental documentation. Alternately, 
> coWiki could be used for the entire site, the disadvantage there that 
> it's pretty much harder to put it together as part of the build.

We at least have to have a decent uplink then for the times when Spring
becomes really popular :)


Regards,

Alef