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

List:       kde-core-devel
Subject:    Re: [vampyr@atconnex.net: *USE* the GUI keyword please!]
From:       Richard Moore <rich () ipso-facto ! freeserve ! co ! uk>
Date:       2000-10-29 20:09:14
[Download RAW message or body]

To be honest, I didn't even know this convention existed. :-(

I don't think there can be any objections to using it though,
it's self evidently a good idea. Are there any other such tags
(eg. for message changes?).

Rich.

Simon Hausmann wrote:
> 
> I was asked (on IRC) to forward this.
> 
> Bye,
>  Simon
> 
> ----- Forwarded message from Lauri Watts <vampyr@atconnex.net> -----
> 
> From: Lauri Watts <vampyr@atconnex.net>
> Date: Sun, 29 Oct 2000 14:04:53 +0200
> Cc: kde-doc-english@kde.org
> Subject: *USE* the GUI keyword please!
> 
> Hi guys,
> 
> It's been brought to my attention that some developers aren't using the GUI:
> tag in their CVS log entries, because they assume that with the amount of
> changes going on, it's unnecessary and we (the documentation team) can catch
> up at the next feature freeze.
> 
> It's patently obvious that this didn't work last time, and there's no reason
> to expect it to work next time either.
> 
> This is a request from the doc team to please USE the GUI: keyword when you
> make changes that affect the GUI of your application, or that will require a
> change to the documentation.  Even if we don't keep up immediately, because
> we're mostly working in the 2.01 branch, at least this way we get a chance to
> try.
> 
> There are a lot of people out there making a lot of effort behind the scenes
> to make KDE a good experience for the user.  While it may seem obvious to you
> how an application works, and what each menu item does, it's not always
> intuitive to the user.   Good and accurate documentation is vital to KDE's
> success, just as vital from the user point of view as adding a new feature
> that only a small subset of people will use.  Nobody will be using any of the
> features if they can't find them, or can't figure out what they do.
> 
> Giving us the opportunity to keep up with changes as they happen, even if it
> means that a particular item is changed 3 more times before the release,
> results in much less frustration than having to practically rewrite a
> document from scratch at the last minute when changes to how it works weren't
> brought to our attention.  This second situation happened several times in
> the run up to the KDE 2 release, but now we have a mechanism in place to
> prevent this, so please use it.
> 
> --
> Lauri Watts,
> KDE Editorial team
> Köping, Sweden
> 
> ----- End forwarded message -----

-- 
     Richard Moore		rich@ipso-facto.freeserve.co.uk
http://www.macromedia.com/	rjmoore@macromedia.com
http://developer.kde.org/	rich@kde.org

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