KDE Developer Documentation

Juan Carlos Torres jucato at kdemail.net
Mon Dec 23 11:00:43 GMT 2019


Greetings KDE developers and community members!

In March this year, we started on a journey to take stock of our developer
documentation and what needs to be done to make them not only more helpful
to current contributors but also more inviting to new ones as well as
external users of frameworks.

The formal work ended in June and I submitted a full report [1] that
included an analysis of the current state of developer documentation as
well as the proposed actions the community could take together in the
months and years ahead. Unfortunately, due to personal and family
circumstances, I was unable to follow the matter up and for that, I am
truly sorry.

Six months have passed since then and while the initial report still holds
true, events and situations have opened new opportunities for the community
to focus on. An updated report [2] was submitted to the e.V. reflecting
these small but important changes. Here is a brief summary of the points in
the reports.

1. With Qt 6 and KDE Frameworks 6 underway, it is both all the more
important and also a perfect opportunity to update our API documentation
and make sure that they are complete and in good quality.

2. There is a growing interest in mobile devices and convergent experiences
which is a good chance to attract more developers into Kirigami and Plasma
Mobile. Updating the developer documentation and documentation systems for
these two projects will be important.

3. While still important in order to maintain an orderly environment,
cleaning up and organizing the wikis now takes a lower priority. That said,
certain aspects like guides for new contributors and external developers
are just as or even more important now than ever.

4. Since many parts of the developer documentation, particularly those
related to Frameworks, might be in a period of transition or rapid change,
it might be more practical to focus on creating content first in a
temporary staging ground before having writers deal with different systems
and software. The Wikis are perhaps suited for this kind of workflow.

These are just some of the high-level points from the two reports and those
documents contain more precise suggestions for the next actions to take.
Again, I apologize to the community for dropping the ball for so long and I
am very excited to get it rolling again. Let's make KDE and its developer
documentation rock even more!

Attached files:

1. 01 KDE Developer Documentation Update Project Report.pdf
2. 02 KDE Developer Documentation Report Update - 2019-12-09.pdf

-- 
Regards,

Juan Carlos Torres
Jucato
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.kde.org/pipermail/kde-community/attachments/20191223/52a14f33/attachment-0001.html>
-------------- next part --------------
A non-text attachment was scrubbed...
Name: 01 KDE Developer Documentation Update Project Report.pdf
Type: application/pdf
Size: 278784 bytes
Desc: not available
URL: <http://mail.kde.org/pipermail/kde-community/attachments/20191223/52a14f33/attachment-0002.pdf>
-------------- next part --------------
A non-text attachment was scrubbed...
Name: 02 KDE Developer Documentation Report Update - 2019-12-09.pdf
Type: application/pdf
Size: 60885 bytes
Desc: not available
URL: <http://mail.kde.org/pipermail/kde-community/attachments/20191223/52a14f33/attachment-0003.pdf>


More information about the kde-community mailing list