I don’t know if people really read docs for apps nowadays, i certainly have yet to do so in my life, since there are search engines out there. So i don’t know of the value in them compared to how much work it is to make a comprehensive documentation. But I’m somewhat interested in helping with it.
This could be checked by someone with acces to site stats. please.
on the other hand, if the docs would be updated, they could be more prominently showcased for people
the below are my random and unstructured thoughts i had about the whole docs situation
I have no clue where to start with something like this, or even who to ask, where to contrib even
-
plasma has it sown documentation (but with a lot of standalone files, wouldn’t it be better to have a single one?), which would be a gargantuan task to modernise, espescially with an x11/wayland split in it
-
kde apps documentation (one foss project i know of with good and kept up to date docs is libreoffice)
-
abismally old - 2014 era, but i don’t know exactly what version each docu is written for, -since that is missing whereas it should open with that like: “The Kate Handbook for the 25.12 series” similar to how it is for libreoffice
-
Is there a document on how to create documentation? like answers for my below questions would be in it. (similar to the kde HIG for development, style guide, layout guide, contribution guide, license/acknowledgement guide, way to go through the apps for the documentation, to have somewhat of a similar order to them where appplicable, should extra packages used by apps be listed in a section and explained how they expand the apps functionality?)
-
I don’t know if the 4 month cadence is sustainable, espescially if there is no system to report ui-ux changes to the documentation team (only the main version to get a document, point releases are bugfixes anyways, except when they aren’t like kdenlive where a 24.08.3 got rid of a supported os version of macos because of qt transition (dont remember exact version)) should this even be in the handbook, or just the features the app supports and not what platform?
-
are there some people over at the document foundation that could help with starting this?
-
use a clean user profile (to have a clean app) with some example files to show off the app
-
dont have the name of the file at the top of each and every page
-
font to be used all over, and its size
-
license, is it okay to redo the license if the documentation is redone? for like CC-BY something? this could be answered by the kde ev guys and put in the docu guide.
-
what about previous versions, and their contributors, since the last release of these docs, a decade has passed, add a historic section to them at the end?
-
also, do the shortcuts work cross platform in the apps? would those need extra testing in vms and os specific (mainly thinking because of macos) notaion?
-
the whole docs.kde.org would need a revival from 2014 as well, with the links as well
the sidebar for choosing the apps documentation on the left at docs.kde.org is soooo bad/old -
maybe add a dropdown search ofr appname/appversion(supposedly this should be supported based on the landing info, but is actually lacking on the site)/applanguage, documentation brach sounds weird, is it really needed, or is that where new stuff would get added?
-
the above is espescially important, beacuse i don’t want to get rid of the old documentations, clearly a lot of effort went into that
-
serve both the raw and the pdf file for people
-
upload the raw file from which the documentation pdf is generated so down the line it’s easier to contribute
-
libreoffice lists the link to the raw odt file as well
Published - The Document Foundation Nextcloud
though for some reason i cant open their pdfs
use open source file formats for this, odf -
something like nates blogpost should really be part of the okular documentation, instead of a random blogpost somewhere who knows where: Tips & tricks: handwritten signatures in Okular – Adventures in Linux and KDE