AW: [wp-docs] Wiki

milquetoast at telus.net milquetoast at telus.net
Mon Dec 29 12:03:36 CST 2003


Quoting Christian Balzer <TigerDE2 at web.de>:

Hi!
<SNIP>
Additionally, it is Not-A-Good-Idea (TM by http://tortoisesvn.tigris.org/ 
docs ;o)) to restrict write access on the wiki. It is, however, a good idea to 
read through new docs before they become "approved". (That idea is not only 
good for hacks.)
** What is your reasoning for not restricting write access to the wiki?**

Plus I wouldn't make the wiki the "official" doc page. It should be more of a 
workground / beta doc, where we built new pages. (Which doesn't mean we 
shouldn't link it...)
** The wiki has always been thought of as a "scratchpad" of sorts, and was 
never meant to be the official place for documentation. It is exactly a set of 
beta documents.**

<SNIP>
Logging in before we edit is a good idea, too. Signing every page is not. 
(There's a wonderful dif function built into the wiki, which keeps track of 
LogIn names / IP's for that.)
**I'm not sure what you mean by signing every page? Once you are logged in, 
your "signature" follows you from page to page, so any changes you make will be 
noted with your log in name. Also, Cena's point about knowing whose idea it was 
to do something a certain way, or write a particular piece is important, so 
that discussion/debate/assistance can be directed at the person right away. 
There's no sense in trying to track someone down to find out where they got 
certain information or why they did what they did. Being able to know right 
away who made a change, and what that change was, makes the wiki concept more 
meaningful and relevant.**

That's it for the moment.
Christian

P.S.: We should agree on a common navigation (=Brainstorming) layout and 
categories (and maybe a license? =Brainstorming) before adding new pages.
** Post a draft of your ideas so that they can be examined and discussed. 
That's what the wiki is for. Anything can be altered as needed, so go ahead and 
put your ideas down on the Brainstorming page and then let us know about it so 
we can check it out and offer whatever opinions or comments that we feel are 
necessary.**

PP.SS.: I'll be away for the next 5 days, so Happy New Year... ;)
** Happy New Year to you too, Christian!**

PPP.SSS.: Before I forget about it: Keep the docs short and simple. People will 
have to read it, and overdocumentation is as bad as no documentation...
** It will always be a challenge to find the right balance for this. Some will 
want exhaustive explanations of things, while others are satisfied with 
overviews. I think that each bit of documentation will have to be examined for 
lack of or excessiveness of detail.**

PPPP.SSSS.: (<= That's getting funny...) I need your opinion on the German 
start page. (=DocIdea)
** My opinion on any translations is that they should wait until the 
documentation is less volatile in nature, to avoid doing a lot of work only to 
have a bit changed completely or perhaps dropped once Version 1.0 shows up. 
Other than that, I think that having multilingual documentation is great, as 
long as we can find someone to do it and then keep it updated! :)

Sorry if I wrote confusing stuff, I'm just too tired right now to write in 
decent English... :)
** Christian, your writing is better than many whose English is their FIRST 
language! ROFLOL!!**

Craig.




More information about the docs mailing list