[kde-doc-english]documentation style

Philip Rodrigues phil.rod at ntlworld.com
Wed May 8 20:13:35 CEST 2002


-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

On Tuesday 07 May 2002 10:43 pm, Divakar R wrote:
> This is with regard to proof reading documentation.
>
> 1. Is active voice to be changed to passive voice?

I personally would say no, not necessarily, unless the active voice is untidy. 
I think overuse of the passive voice can be too 'dry', and we want the 
documentation to be at least slightly friendly (I assume). Others may know 
better than me.
>
> 2. Is the use of first person (as in "I will call this meta DTD...") by the
> documentation author to be removed?

I have no strong opinion, but in a list of "Proposed message string 
standards", forwarded to me by Malcolm, it says that the proofreading team 
will not change the voice or style of the documentation, so I guess that 
rules out changing the person used.
>
> 3. Where can I find a list of names for standard controls in GUIs? For
> example, which is correct - spin box or spin control?

The 'Visual Guide to KDE' in khelpcenter is what you're looking for. It's 
under Tutorials, and gives spinbox as the correct form of what you're looking 
for.

Regards,
PhilRod

- -- 
"Let everyone sweep in front of his own front door, and the whole 
world will be clean."
        -- Goethe
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.0.6 (GNU/Linux)
Comment: For info see http://www.gnupg.org

iD8DBQE82WrdG5ddmRpv1VERAot0AJ4pHaDVkxGnDZN1X6EVFFvedsqjzwCgyva3
WuFgVzIS71vd5E8YWquxEtM=
=nlVs
-----END PGP SIGNATURE-----




More information about the kde-doc-english mailing list