Re: documentation support
Olivier Churlaud <[email protected]>
| Newsgroups | gmane.comp.kde.events |
|---|---|
| Message-ID | <BE1B07FB-5CEC-4CEE-90D5-DF41E9669FB4__46824.1726900034$1536000846$gmane$org@churlaud.com> |
Sorry for top posting (writing from my phone). I totally concur to what is said here. And in my opinion the documentation "supporter" should have the same conclusion. The problem will be on how to priorize between userbase.ko and api.ko Le 3 septembre 2018 19:31:33 GMT+02:00, Scott Harvey <[email protected]> a écrit : >Can I make a polite suggestion? It would be wonderful if our contract >technical writer could be allotted a slice of his/her time for the >following - documenting "how to use {X}" along with "what {X} does". We > >have a lot of material in api.kde.org that explains how things work, >but >there's not always a lot that explains how to use these items properly >and get the desired result. With all due respect - and I mean that very > >sincerely - the Plasma framework contains a whole lot of material, for >which a lot of the "what" is already documented. What's missing is how >to employ those things to make something happen or behave the way the >(newer) programmer wants. > >Some of it's in the Plasma API docs, some of it's in the official >Qt/QML >docs, some is partially explained on wiki pages, and some of it is >inside the heads of our best Plasma programmers (or at least the proper > >way to combine X, Y, and Z to get result A). For the record, that's a >compliment to our Plasma coders, not a complaint. > >I look forward to seeing the outcome of this project. Having worked in >the corporate world with and without good documentation, technical >writers and documentation writers are people to be cherished and >appreciated. Their work makes everyone else's work so much simpler. > > >On 8/30/18 2:45 PM, Lydia Pintscher wrote: >> Hey folks :) >> >> The e.V. is looking for someone to help us with documentation around >> KDE. The call for proposals is here: >> https://ev.kde.org/resources/marketingsupport-callforproposals.pdf >> It'd be great if you could help us spread this as you see fit. >> >> >> Cheers >> Lydia >> -- Envoyé de mon appareil Android avec Courriel K-9 Mail. Veuillez excuser ma brièveté.