[Wocky] Draft install docs, version pages and PFDs

William Cattey wdc at MIT.EDU
Tue Jun 13 16:32:08 EDT 2006


I have given a cursory read of the Gaim for Windows docs, and they  
seem fine to me (but someone more intimately familiar with Windows  
ways should  go over them carefully.)

I've gone over the Adium X documents and have a couple suggestions:

1. typo:  The version page reused text from the Gaim page.  Change:
"IS&T does not support using Gaim with external systems."
to
"IS&T does not support using Adium X with external systems."

2. Should the First Time Install directions cross link to the upgrade  
instructions?Maybe change:

The following instructions are for a clean install, that is, Adium X  
has never been installed on this computer.

to:

The following instructions are for a clean install, that is, Adium X  
has never been installed on this computer.  If you are doing an  
upgrade, use the <link> upgrade instructions</link>

3. Should the Upgrade directions cross link to the first time  
instructions?
Maybe change:

The following instructions are for an upgrade, that is, an older  
version of Adium X has been installed on this computer.

to:

The following instructions are for an upgrade, that is, an older  
version of Adium X has been installed on this computer.  If you are  
installing Adium X for the first time, follow the <link> instructions  
for first-time installation </link>.

I make the two suggestions above with the recognition that cross  
linking may not be a good idea, and leave it up to those taking care  
of the docs to decide if they want to cope with the added maintenance  
work.

4. We discussed how, if you're using the MIT installer to do an  
upgrade to a non-MIT installer, it does not go looking for the non- 
MIT version. It just installs.  I suggest adding the following  
additional prose to the upgrade installer.

The MIT installer puts Adium X in a different place than the  
installer provided from the Adium X web site.  If you are switching  
from theirs to the MIT version, you should remove the Adium X  
application by hand, and follow the instructions for a First Time  
install.

Hope this review is helpful,

-wdc

On Jun 5, 2006, at 12:01 PM, Heather Anne Harrison wrote:

>
> Hi All,
>
> Here are the docs
>
> Gaim:
>
> Install - http://itinfo.mit.edu/article.php?id=8120
> PFD - http://itinfo.mit.edu/product.php?name=gaim
> Version Page - http://itinfo.mit.edu/product.php?vid=703
>
> Adium X:
>
> Install - http://itinfo.mit.edu/article.php?id=8119
> and http://itinfo.mit.edu/article.php?id=8118
> PFD - http://itinfo.mit.edu/product.php?name=adiumx
> Version Page - http://itinfo.mit.edu/product.php?vid=704
>
> Please review and let me know if you have any feedback.
>
> Thanks!
>
> Heather Anne
> aurora at mit.edu
>
>
>




More information about the Wocky mailing list