Dug contents

Karsten Wade kwade at redhat.com
Tue Dec 11 18:13:54 UTC 2007


On Tue, 2007-12-11 at 09:18 -0500, Dan O'Brien wrote:
> >   
> I refrained from adding to many pictures because I saw something
> mentioned in another post about it being harder
> when it comes to translating the document. I can definitely add more
> pics if you'd like? I still have some from
> when I did this page originally.

We called out this type of page as being an exception to the rule.  It
is useful to show the pieces of the desktop when describing how it all
works.  This use to be how the GNOME intro was handled, but it looks as
if those were removed.

Sorry about the confusion; let's see if this clears it up, then I can
update the appropriate StyleGuide pages.

For example, imagine a section in a document that explains how to use a
mouse.  It would be useful to show a picture of the mouse icons and
explain what they mean -- the arrow, the clicking HTML hand, the timer,
etc.

When that document section gets to explaining about the mouse
preferences dialog, there is no need to show the GUI; explaining it is
better, for the reasons you allude to about pictures being harder to
deal with in many ways.

If the section was on "understanding GUI elements" then you would
certainly show GUI elements in explaining.

In this way, the images work as simple diagrams.  A diagram is something
useful in a document, where a screenshot often is more trouble than it
is worth.

- Karsten
-- 
Karsten Wade, Developer Community Mgr.
Dev Fu : http://developer.redhatmagazine.com
Fedora : http://quaid.fedorapeople.org
gpg key : AD0E0C41
-------------- next part --------------
A non-text attachment was scrubbed...
Name: not available
Type: application/pgp-signature
Size: 189 bytes
Desc: This is a digitally signed message part
Url : http://lists.fedoraproject.org/pipermail/docs/attachments/20071211/aff0521a/attachment.bin 


More information about the docs mailing list