Tom Wickline wrote:
We have decided to continue this discussion in public
I forgot to ask about sections 4-8 on Dimi's ToDo page.
http://www.dssd.ca/wine/Wine-0.9-TODO.html
- Merge documentation/wine.texinfo into the Development Guide [TODO]
- Merge documentation/HOWTO-winelib into the Development Guide [TODO]
- Do something about
documentation/installation-und-konfiguration.german [TODO] 7. Do something about documentation/shell32 [TODO] 8. Do something about documentation/status [TODO]
Are we going to be doing any work on these sections as well ? Will your Task List take these sections into account ?
I think that we should keep the documentation tasks togetther. If its OK with Dimi we can just use his page and give him diffs or we can split off the documentation section and he can link to it.
If our goal is to " Fix incomplete and/or out of date documentation." Then we should do the Merge as well so everything will be complete.
wine.texinfo is like a man page and it seems to be updated fairly well. I don't agree with trying to get rid of it but I am not about to be the one to maintain it either.
The wine How-to should be part of wine users. Once it is merged we should get rid of it.
I really dont know what to do about installation-und-konfiguration.german. I am inclined to leave it for now
#7 and #8 I dont fully understand what needs to be done here. Can you fill me in on what needs to be done with these two ??
From what I can tell these should be incorporated into the wine status page. This seems to be the logical place for them. Most of the files are a year or more old so I would tend to think that they are out of date. Whoever does this will probably need to ask some questions to the developers.
In theory Each DLL should have a ToDo list inside the main .c file (or something like that (i can't fine the thread)) a little help here? Having these in documentation is doing neither the users or the developers any good. Again in "theory" someone could grep for "To Do" in wine and get a good idea of the status of that component.
Also are we going to be doing any work on man pages ? If not does Dimi need to add them to this list ? I'm sure if the web docs are out of date then the man pages need work as well.
From what I can tell the man pages are the best of the lot.
Right now we could use someone "New To Wine" to go through the users guide one chapter at a time and report to us *anything* they don't understand.
Anyone is welcome to point out errors and offer any suggestions to help improve the documentation. Of course a patch is even better but if we do not know about a problem we can not fix it.
I think that we should keep the documentation tasks togetther. If its OK with Dimi we can just use his page and give him diffs or we can split off the documentation section and he can link to it.
I ask Jeff Smith if he would be interested in helping with a task list page and he said he would be more than glad to. A broke down list of task would make things much more easier for would be newbie voilinteers to grasp.. And im sure Dimi would link it in. And this would not clutter his nice .9 page And since we are working on this it would make changing the task list a simple task in its self.. without having to ask dimi to make changes everytime somthing changes ... Comments ?
If our goal is to " Fix incomplete and/or out of date documentation." Then we should do the Merge as well so everything will be complete.
wine.texinfo is like a man page and it seems to be updated fairly well. I don't agree with trying to get rid of it but I am not about to be the one to maintain it either.
We could do the merge and let the current maintainers maintain it correct ? Comments ?
The wine How-to should be part of wine users. Once it is merged we should get rid of it.
OK.. But what about "The Perfect Enduser Wine Debugging Guide" are we going to do anything with this ? From the front page.. Needs improvement/contributors ! Gets merged into Developers Guide as soon as layout is rock-solid.
I think we should go ahead and merge it now.. As it does not look as it will ever become rock solid. And get rid of it as well ... Comments ?
I really dont know what to do about installation-und-konfiguration.german. I am inclined to leave it for now
Recrute a german speaking person to help with this ??
Right now we could use someone "New To Wine" to go through the users guide one chapter at a time and report to us *anything* they don't understand.
I will read over everything starting this monday. anyone else want to volinteer to read everything and give thoughs on how to improve our Documentation? Great for a newbie lurker who wants to help out :))
Anyone is welcome to point out errors and offer any suggestions to help improve the documentation. Of course a patch is even better but if we do not know about a problem we can not fix it.
I agree Documentation is absolutly essential to the wine project. The better the documentation the more usefull the product is. And if we are seriouse about a future .9 or 1.0 release we should have the Documentation to back that release up. Wine is still not the easiest program to use.. And when 1.0 comes out and the word spreads im sure there will be a flood of downloads... And if the Documentation *SUCKS* for say!! it will only take wind out of our sail.. So now is the time to really start on this and get everything in order for 1.0 in 2003 !!!
Intergetic Volinteers wanted .. please apply here........ lotsa fun guaranteed or your money back....
Tom
On December 26, 2002 05:31 pm, Tony Lambregts wrote:
I think that we should keep the documentation tasks togetther. If its OK with Dimi we can just use his page and give him diffs or we can split off the documentation section and he can link to it.
I am more than OK with it, I think it's the way to go. Having the TODO split in 1000 places defeats the purpose of having a TODO list in the first place. Moreover, look at the other TODOs: they don't change that often... :)
wine.texinfo is like a man page and it seems to be updated fairly well. I don't agree with trying to get rid of it but I am not about to be the one to maintain it either.
No, it had no serious updates since '98. It's out-of-date, and unmaintained. It does need to be merged with the docs we have. Alexandre explained this some time ago. The TODO entry is still valid IMO.
I really dont know what to do about installation-und-konfiguration.german. I am inclined to leave it for now
Yes, it's a tough nut to break. Personally I think translated docs at this point hinder us a lot more than it helps. Most of our documentation is out-of-date, translating it just makes the problem worse. But that's just me...
#7 and #8 I dont fully understand what needs to be done here. Can you fill me in on what needs to be done with these two ??
Yes, they need merging with the code, or in the documentation, as Tony already explained.
From what I can tell the man pages are the best of the lot.
Yes, Alexandre takes care of those usually, these are the last things you should worry about. In other words: don't. :)
Right now we could use someone "New To Wine" to go through the users guide one chapter at a time and report to us *anything* they don't understand.
That would be a superb test, indeed. But maybe we should first fix the gaping holes before we subject an unsuspecting individual to the task :)
Dimitrie O. Paun wrote:
On December 26, 2002 05:31 pm, Tony Lambregts wrote:
I think that we should keep the documentation tasks togetther. If its OK with Dimi we can just use his page and give him diffs or we can split off the documentation section and he can link to it.
I am more than OK with it, I think it's the way to go. Having the TODO split in 1000 places defeats the purpose of having a TODO list in the first place. Moreover, look at the other TODOs: they don't change that often... :)
OK....... Fine with me can we just break this down to smaller task ? One huge task is a bit overwhelming to a would be helper. And if this was broke down to smaller task more people might want to take over a small manageable task IMHO.
Tom
On December 28, 2002 02:25 am, Tom Wickline wrote:
OK....... Fine with me can we just break this down to smaller task ?
Of course, we must break it down further. It's just that I did not know how to do it, and I was hoping someone more familiar with the documentation will do it instead.
Dimitrie O. Paun wrote:
On December 28, 2002 02:25 am, Tom Wickline wrote:
OK....... Fine with me can we just break this down to smaller task ?
Of course, we must break it down further. It's just that I did not know how to do it, and I was hoping someone more familiar with the documentation will do it instead.
Well I am quite busy right now on non-wine related stuff... Sorry...
The Perfect Enduser Wine Debugging Guide is supposed to be an expert system. I am inclined to _not_ throw it out but it needs a maintainer. For now I'm just going to pretend it isn't there. Thats me though (can't seem to throw anything out.)
As far as translations go I think the README is as far as I would go.
As for ther rest of the Docs. IMO the Wine Users Guide should probably be in the LDP. is there a reason that its not there? licence?
When I get time I would like to go over the developers guide. Houwever it will probably be at least a week untill I can do so.
-
Dimitrie O. Paun -
Tom Wickline -
Tony Lambregts