Using userbase for manuals

Ingo Malchow imalchow at kde.org
Sun Jul 1 15:50:29 BST 2012


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

Am 01.07.2012 15:33, schrieb Albert Astals Cid:
> El Diumenge, 1 de juliol de 2012, a les 14:37:44, Alexander Dymo va
> escriure:
>> 2012/7/1 Eike Hein <hein at kde.org>:
>>> Ultimately Albert isn't wrong with his concern, but the
>>> reality seems to be that we just can't get our act together on
>>> the offline documentation while maintaining the wiki comes a
>>> lot easier to us. And it's better to have wiki documentation
>>> than no good documentation, IMHO.
>> 
>> I 100% agree with Eike. Albert is right, but in reality there're
>> two things we need to consider 1) documentation maintainability 
>> development teams consistently fail to maintain documentation,
>> so quality and completeness get hurt
> 
> That's why we have an amazing documentation team at
> kde-doc-english at kde.org
> 
> They will be happy writting/updating your documentation, you only
> need to tell them where and what needs work and you'll get a new
> and shiny docbook
> 
> I just got the Okular one updated by them and I didn't even answer
> for it :-)
> 
>> 2) user involvement for KDevelop the best documentation is
>> usually written by users, userbase wikis are a better way to
>> involve users than docbooks
> 
> I don't agree with that, users are good writting tips for eachother
> but not necessarily good at organizing the content in a coherent
> and sensible way.
> 

I don't think it boils down to have either the one way or the other,
but how to combine both of them.

Use help of users and simplify the way of contribution and on the
other hand provide a coherent and sensible way to produce nice
documentation which is even up to date.

> Cheers, Albert
> 



- -- 
Ingo Malchow
(neverendingo)

-----BEGIN PGP SIGNATURE-----
Version: GnuPG v2.0.18 (GNU/Linux)
Comment: Using GnuPG with Mozilla - http://enigmail.mozdev.org/

iEYEARECAAYFAk/wY7QACgkQgFDgF4YW7seoIwCgmT1flD4KOJkd90FHixD9+83m
UXQAn0gAtnCPCGyrH+oDaLTon/XzBCy0
=jzF8
-----END PGP SIGNATURE-----




More information about the kde-core-devel mailing list