Documentation work -task list -man pages

[Tony Lambregts]

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

>
>
>    4.  Merge documentation/wine.texinfo into the Development Guide [TODO]
>    5. Merge documentation/HOWTO-winelib into the Development Guide [TODO]
>    6. 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.


-- 

Tony Lambregts