Re: some action

From: Date: Fri, 21 Jan 2005 16:23:05 +0000
Subject: Re: some action
References: 1 2  Groups: php.pear.doc 
Request: Send a blank email to pear-doc+get-5457@lists.php.net to get a copy of this message
Anatoly Techtonik wrote:
Hello Lukas,
I am splitting up my answer two. My idea was to promote this all as a single action, but the details can be worked out separately.
LS> Once we have the wiki up. We should define rules on how documentation LS> should be written in the wiki. Preferably in a manner that will allow us LS> export to docbook (immediatly or eventually). Perhaps I misunderstood idea again, but this is my general POV on the issue.
From my WikiPedia and TikiWiki experience limiting wiki is not a good idea. Only if you are very strong person. =) And it is very naive to think that others will obey. =)
See my other mail. Generally though I see it as the task of the doc team to ensure that the structure is kept. So generally all doc content is good. I think however users will usually appreciate guidance is layout (so call it a guide) and they will certainly appreciate structured API docs. See my reply to Paul for further comments.
The same idea but in other words: "user appreciation" will not work because this idea is alive only in the mind of several people. Hence it is dead idea. If you've made such system and nobody uses it, you can, of course, write rules and oblige others to follow it, but you will probably loose contributors that way.
If there is no "user appreciation" then thats fine with me. Then atleast we know there is none and we can stop worrying about pleasing people who dont appreciate our work anyways. However my idea was that we annouce both actions at the same time. I am also hoping that the new wiki itself will motivate people. If not so be it. Its not like we will loose much if none of our users take up this opportunity to actively help steer PEAR in the right direction.
Wiki information refactoring for documentation quality is the job of maintainer and QA team. And because CVS access is limited to PEAR documentation group - it is their job too. :p
Yeah .. like I said above. But we dont have to make their job needlessly hard. regards, Lukas

« previous php.pear.doc (#5457) next »