Brant Langer Gurganus wrote:
Sent to: Ian (Help Browser), Steve (Help Content), Asa (Mozilla
General), Documentation Newsgroup
Regarding my documentation review and update, I have the following
questions:
* Few, if any, Help files contain the license boilerplate. Do I
need to add this? If so, which variant?
We don't have a documentation license so I'm not sure what to do about the content. The Help Viewer should be appropriately licensed with one of the Mozilla licenses.
* Mainly for Ian, can id's on any element be used instead of name's
on the a element to identify destinations for contents and such.
The main reason is the name is lingering toward deprecation and it
also causes some weird scrolling issues where half of a line is
showing.
* Since a possible future move for the Mozilla Suite is to make each
part individually installable, should I try to separate things
along product lines so that it will be ready when the time comes?
In addition, could it even be possible to create separate packages
which composite together in Contents, Index, etc? I think this
would be possible with some tweaking.
I think that the Help system should be as componentized as possible. To me that means both unbinding it from the Apps and organizing content into modules so that distributors/users who have an installation without, for example, Composer don't have to wade through Composer help docs. I'm not sure where we are on either of those. Ian would know more than me.
* Given that Mozilla is more of a developer-centered product, how
user-centered does the Help need to be and should things like
Chatzilla, DOM Inspector, etc. be included?
Distributors are often going to reuse our help system. Some distros will include the developer tools kike DOM Inspector and Venkman. Other distributors won't. The same goes for all of the main apps, Browser, Composer, MailNews, Calendar, and Chatzilla. If possible, we should have a help system that can be easily distributed with the various configurations.
--Asa
