-On [20080516 00:41], Noah Kantrowitz ([EMAIL PROTECTED]) wrote:
>A wiki exists for communication, taking quick notes, and to act as a
>general buffer between both developers and the community. It is _not_ a
>system to write good technical documentation.

Fully agreed in my capacity as a technical writer/programmer.

>Our actual documentation is another 
>story. One big reason to move to ReST files in Subversion is we gain easy 
>branching, thus warding off the current insanity with 0.1[012]/* page names 
>and such. It also allows us to move to a submit-a-patch workflow as we do 
>with code. Documentation is just as critical as any other part of the 
>project, and as much as I like community involvement, it has become clear 
>through experience that wikis do not work for our needs.

Peer review has been difficult, in my opinion, with the wiki. This lead to a
lot of problems with the structure of the documentation, making it hard to
find the appropriate things.

>I currently see things being broken into 4 main doc trees: guide (user 
>docs), admin (administration guide), install (install process), and api or 
>dev (developer reference and tutorials).

Agreed.

-- 
Jeroen Ruigrok van der Werven <asmodai(-at-)in-nomine.org> / asmodai
イェルーン ラウフロック ヴァン デル ウェルヴェン
http://www.in-nomine.org/ | http://www.rangaku.org/ | GPG: 2EAC625B
If Winter comes, can Spring be far behind..?

--~--~---------~--~----~------------~-------~--~----~
You received this message because you are subscribed to the Google Groups "Trac 
Development" group.
To post to this group, send email to [email protected]
To unsubscribe from this group, send email to [EMAIL PROTECTED]
For more options, visit this group at 
http://groups.google.com/group/trac-dev?hl=en
-~----------~----~----~----~------~----~------~--~---

Reply via email to