[prev in list] [next in list] [prev in thread] [next in thread] 

List:       kde-i18n-doc
Subject:    RE: [kde-doc-english]3.2 freezes
From:       José_Nuno_Pires <jose.npires () optimus ! pt>
Date:       2003-09-16 13:08:20
[Download RAW message or body]

> One suggestion : if there not time enough to write docs, one could spare >some 
> time, writing smaller docs. I think KDE docs are too detailed. ("Click with 
> the left button of the mouse on menuitem xxx, submenuitem yyy to open a 
> dialog box yyy..."). Just "Use menu xxx/yyy to open settings...".
 
> This sort of writing saves time to the writer, the translator and the >reader.
Yes, but we can't forget the reader. When we start cutting on documentation, what can \
seem obvious to the developer or to the translator, it may not look that obvious to \
the user.

> Also, the trivial functions could be not documented :
> "Clicking on <<File Open>> opens files..." is this sort of explanation >useful 
> for anybody ? Some more acurate explanation should more useful (why does it 
> not work on my computer ? What is a file ? What is opening files ? Which 
> sorts of files can be open that way ? How many in the same time ?)
Watch my comment above. If we want an end-user with little or no knowledge of \
computers, we can't cut on clearness.

> At the opposite, I sometimes read some docs like this :
> "Activate xyz". This checkbox activates xyz function.
> OK, but what is xyz function ??
Yes, I agree that some ideas are quite loose on some documents even to me, a \
translator; to an end-user, those concepts will look looser.

> I think KDE-usability should be more concerned by the writing of the docs.
Agree.

Hope these few ideas can help

Gerard, translator.


[prev in list] [next in list] [prev in thread] [next in thread]