Adium doc structure

[Evan Schoenberg, M.D.]

On Jun 1, 2010, at 4:18 AM, Robert Vehse wrote:

> I am interested in your opinions on how we should structure Adium's documentation. This is a question I have been pondering over for some time but this has become more important since recently, two friendly chaps have expressed interest in helping with documentation. Mike Crilly already mailed the list about the Adium Book he is working on, the other guy would like to work on the Help pages as he has some HTML and CSS knowledge.
> 
> Peter Hosey once said
>> I want less in the wiki and more in the manual. Long-term, anyway. What's in the wiki, we should move to the Help, and then we just link to the Help."
> 
> I agreed with that. My idea was to complete the documentation in (in-app) Help and only leave the following components on the Wiki:
> - Development
> - Directions on where to get support
> - TroubleshootingTips
> - Instructions on how to create Xtras
> - Community links (cf. http://trac.adium.im/wiki).
> 
> However, of all these ideas, I like the Adium Book best. What do you guys think? Would we want to duplicate the information the book gives in Help? What information should stay on the Wiki? etc.
> I'd appreciate your input.

The Adium Book approaches a comprehensive manual of sorts; I think it is a parallel resource to, not a replacement for, the in-app Help system, which is much more narrowly focused in each of its pages and solutions.

We should be able to include a checkout of the HTML-based in-app help on the website easily, as Peter mentions; content on the wiki should be transitioned to that, and then would be available both within the app and for online reference.

-Evan
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://adium.im/pipermail/devel_adium.im/attachments/20100607/464024da/attachment-0002.html>