Giving KDE developer docs some TLC

In the course of its twenty-two years of existence, the KDE community has created an impressive amount of documentation, from user manuals to internal project discussions to developer tutorials. Like any fast-growing garden, there is a tendency for some things to get a bit out of hand when left unattended for some time. It can be easy to get lost in the outgrowth, especially for first time visitors. It’s time to put on the gloves, take out the tools, and do a bit of gardening!

(Documentation Konqi courtesy of the amazing Tyson Tan)

Last month, I had the privilege of coming on board as a documentation specialist to take a closer look at KDE’s developer documentation and to later come up with strategies to make them better than ever. I have talked with some of the community’s developers to get their feedback on some of the areas that need updating or fixing when it comes to technical documentation. But that’s only one part of the story.

Our dev docs are also meant for new developers. That applies to both new contributors in the KDE community as well as external developers who want to use our software, particularly our excellent KDE Frameworks. In that regard, we’re also looking for feedback on the areas where interested budding rockstar coders and passionate KDE contributors are having trouble getting into the community.

Having clear, up-to-date, and relevant documentation goes a long way in encouraging and helping new developers get involved with the community with as little friction as possible. It even helps those already manning the ship become familiar with other parts of our software they may not have used before. I would love to hear some thoughts and suggestions, especially from interested KDE hackers, so let me know in the comments below.

5 thoughts on “Giving KDE developer docs some TLC

  1. Craft is a really nice tool to download dependencies and set up a dev environment on windows, but once you’ve run the initial build it’s not really clear how to integrate any of it into an IDE or other tools. I wanted to try to chase down a crash that I was only seeing on windows but after spending way too many hours getting trying to build it with an IDE (or anything besides the full craft build) and dealing with craft breaking I ended up giving up.

    1. It’s sadly a by-product of not having that many developers shepherding Windows tools and software. I’ll get in touch with the KDE Windows team to see how I can help. Thanks for bringing this up!

Leave a Reply

Fill in your details below or click an icon to log in: Logo

You are commenting using your account. Log Out /  Change )

Google photo

You are commenting using your Google account. Log Out /  Change )

Twitter picture

You are commenting using your Twitter account. Log Out /  Change )

Facebook photo

You are commenting using your Facebook account. Log Out /  Change )

Connecting to %s

This site uses Akismet to reduce spam. Learn how your comment data is processed.