Re: [GnomeMeeting-devel-list] [Fwd: Re: GnomeMeeting manual]

[Damien Sandras <dsandras seconix com>]

Here is some extract from the GDP style guide :


"Each online Help manual should contain enough introductory information
to tell new users how to start using the application. The online Help
manual should also contain enough usage instructions to tell users the
different actions that they can perform with the application. Keep these
instructions task-oriented. You do not need to describe the GUI screens,
dialogs and dialog elements in online Help."

Everybody who wants to participate in the manual should read it:
http://developer.gnome.org/documents/style-guide/

Snark proposed sections yesterday. As the manual has to be
"task-oriented", I propose the following sections for the main part :

- Calling other users
- Managing my contacts
- Optimizing my settings
- Connection monitoring
- Doing n-to-n conferences
- Doing PC-To-Phone calls


Le lun 03/03/2003 à 19:35, Damien Sandras a écrit :
> FYI
> 
> -----Message suivi-----
> 
> > From: Calum Benson <calum benson sun com>
> > To: Damien Sandras <dsandras seconix com>
> > Cc: Pat Costello <patrick costello sun com>
> > Subject: Re: GnomeMeeting manual
> > Date: 03 Mar 2003 15:17:53 +0000
> > 
> > Hi Damien,
> > 
> > The HIG doesn't really give advice on writing documentation, there's a
> > whole separate GNOME documentation styleguide for that :)  
> > 
> > I'm cc'ing Pat Costello here who wrote much of the docs styleguide and
> > can give you more concrete advice.  But I believe the preferred style
> > for GNOME docs is much like your second suggestion: a task-based rather
> > than functional description of everything in the GUI, and with very few
> > screenshots.
> > 
> > Cheeri,
> > Calum.
> > 
> > On Mon, 2003-03-03 at 14:49, Damien Sandras wrote:
> > > Hello Calum,
> > > 
> > > I don't know if you are the right person to ask for this, but we have a
> > > conceptual problem for the GnomeMeeting manual.
> > > 
> > > Actually, my question is simple :
> > > 
> > > - Some people argue that the GnomeMeeting manual should contain
> > > screenshots of all windows of GnomeMeeting and a description of them. It
> > > means it should include a screenshot of each section of the preferences
> > > window and an explanation of each of the options,
> > > (evne though everything is already explained in tooltips).
> > > 
> > > - Some people argue that the GnomeMeeting manual should contain sections
> > > like "Contacting other users (via ILS, addressbook, ...), Managing your
> > > contacts, Optimizing the bandwidth usage and quality, ..." but not a
> > > description of all options with screenshots of each section of the
> > > preferences window.
> > > 
> > > What is the general HIG advice about that?
> > > 
> > > Thanks,
> > -- 
> > CALUM BENSON, Usability Engineer       Sun Microsystems Ireland
> > mailto:calum benson sun com            GNOME Desktop Group
> > http://ie.sun.com                      +353 1 819 9771
> > 
> > Any opinions are personal and not necessarily those of Sun Microsystems
-- 
 _	Damien Sandras
(o-	GnomeMeeting: http://www.gnomemeeting.org/
//\	FOSDEM 2003:  http://www.fosdem.org
v_/_	H.323 phone:  callto://ils.seconix.com/dsandras seconix com