Building the KDE UserBase
In depth: Most software developers, whether open source or proprietary, would agree that the success or failure of any endeavour depends on building a community. This may be a community of fellow developers, advocates or just users, but unless a significant number of people take a project to their hearts, it's unlikely to make an impact.
If you're an elite coder who dreams in C++, making your mark on a free software project could be relatively easy; you take the code - magically available under the GPL - and work out how to do something new or more efficient with it and then bash out your edits on a keyboard. You release your patch and the community sings your praises while you begin the process over again with the same or another project.
For those of us who dream in boring old pictures, making an impression may seem like a pipe dream, but there are ways that end users can get involved in free software development and help improve not just the software itself, but also the experience of other users. In this case, it's not our (lack of) coding skills that are of use, but the diverse ways we use software and the experiences we can bring to the community.
Enter UserBase and Anne Wilson. The former is a collection of pages dedicating to helping users everywhere get the best experience when using KDE. The latter, meanwhile, is a retired teacher with a passion for Linux, learning and KDE who has become a key contributor to UserBase.
She says UserBase aspires to being the first-stop site for KDE users in search of hints and tips, userfriendly discussion pages and evolving information about applications: "There has traditionally been a great deal of information on the web about KDE applications," she says. "But its scattered nature has made it difficult for users to find, and difficult for developers to maintain."
UserBase, Anne says, is an integral part of the "great reorganisation" going on in the KDE documentation project to address these problems.
See the KDE UserBase homepage (http://userbase.kde.org) for more information about joining in!
Linux Format: How are contributors organised?
Anne Wilson: Organised? What's that? Seriously, this is a wiki. We, the smallish group of original contributors, use the Recent Changes RSS feed to keep in touch, and encourage people to use the Discussion pages when an issue needs resolving. It's no more organised than a chat in the pub, but it works, and it's productive.
It was mid-September when we had our first few pages up and 'went live', inviting contributions. Recently we saw our 200th page arrive, and the statistics page tells us that there have been a total of 197,132 page views!
LXF It's easy to set up a wiki, but difficult to acquire and keep users and contributors. How have you managed to build and retain a successful userbase?
AW:Time will tell whether we have managed to do this. In the end it will depend on two factors - whether users find it helpful, and whether developers find it easy to use for end user documentation.
The first problem was to define clearly the focus of UserBase in terms of what belongs there, and what doesn't. KDE had a wiki previously, but the focus was never defined, and it descended into chaos. Users felt that it was not for them, and developers couldn't work out whether to put information into the wiki, into TechBase, or both, which they clearly didn't want to have to do.
LXF: Are there plans to integrate the project further into the KDE experience?
AW:An excellent idea, but help files don't get written too often, so it will take a little time for that. Currently, though, if you search for an application and find an external project site you may well find that the Documentation page links to UserBase. This is proving the preferred route for many smaller projects. Large projects like Amarok need to keep their own pages, but that's no problem either, as UserBase simply links to project pages. The idea is to make it simple for the user to find the information they need.
LXF: Are there any particular skills that are especially useful in a contributor?
AW:It's easier if you have any experience of MediaWiki, the same software that is used to create Wikipedia, but it's not essential. The easy way is to look for a page that does something similar to what you want to achieve, open an edit on that page, and simply copy the formatting.
There's also a need for translators. Ideally every page should be available in every language. That's a tall order, but we have a language template that makes it easy to add translations. Many pages already have this in place, but where one's needed and not already available, a request on a Talk page should get it put in quickly. Once that's in place, it's a one-click job to bring up the edit page.
LXF Is there a need for documentation maintainers on different parts of the project?
AW:Not really. We have http://userbase.kde.org/UserBase/Guidelines which reminds people about licensing issues and other general issues. An outline of what should and should not be added is at http://userbase.kde.org/UserBase. The rest is pretty much common sense.
LXF: What could Linux Format readers do right now to improve the project?
AW:Think of your favourite applications. Are there features that you didn't notice at first but are invaluable now? Add them to the Hints and Tips section at the bottom of the application page. Not many pages have this section yet, so if it's not there, add it. Just follow the formatting of the rest of the page and if you hit a problem, ask on the Talk page for that application and someone will help you.
LXF: Finally, how important do you think projects like UserBase are to KDE and free software generally?
AW:Absolutely invaluable, if we make them so. For years it has been said that there is no easy way for non-coders to contribute. Well, here it is! Many KDE developers see UserBase as a place where developers and users can contribute equally, providing an incredible resource that uses the experience of thousands of users.
Free and open source software is not based on the idea of 'someone should do something about it' - it is our chosen world and we can make a difference.
- Use Wikipedia-style formatting to create your page. For instance, enclosing a piece of text in three single quote marks ('''text here''') will render the text in bold type. Look at the edit section for an existing page to see how the formatting works.
- If you're unsure of something, use the Talk option to start or participate in a discussion attached to the page.
- Remember to use screenshots wisely. A picture really can enlighten users much better than a long explanation (though sometimes only words will do).
- Anyone can edit pages, but if you want to really get involved, create an account with the site or log in with an OpenID.
First published in Linux Format magazine