Moving KDE Connect out of playground
Luigi Toscano
luigi.toscano at tiscali.it
Tue Sep 15 16:16:17 BST 2015
On Tuesday 15 of September 2015 08:01:44 Albert Vaca wrote:
> I don't think that having "descriptive documentation" (more about this
> later) is that important nowadays, and IMO users will likely google for
> help way before they use the help button when they find issues. Since most
> people I talked to in Randa agreed with me on this, I'm a bit surprised to
> find that you want to enforce this as a strong requirement. I can of course
> write a few lines to meet this requirement, but I would like to start a
> discussion to re-think why we are doing this.
>
> IMO, the kind of documentation that users need is not a list of every
> button in the KCM with a redundant description like the one we provide
> (probably because most projects write it just to meet the requirement), but
> instead answers to questions like "I see error X, what to do?". And this
> kind of help is easier to find online, in wikis, forums, etc. than in the
> static documentation we provide.
>
> Leaving aside the utility of having docs, they are yet another moving piece
> to maintain and likely to become outdated (eg: "Activity Settings" help
> shows a screenshot from KDE 4), specially in a piece of software in change
> like KDE Connect.
>
> To put an example of a similar case, Windows 10 completely removed the
> "Help Center" and now it sends you online to the MS site if you need help.
>
> Why don't we move our docs to the userbase wiki, and make it an open and
> live thing that users can update (ala Arch Linux wiki)? If there are no
> objections, I could start a page for KDE Connect there and make the help
> button in the KCM link to it. Also, since right now we don't have any
> numbers around how many poeple uses our help, moving it to the web would
> give us some nice analytics around it for free.
My requirement for documentation is that could be available both ways, online
and offline. All online it's nice until you are disconnected.
Changing the content of the documentation is fine, of course, but it is a
different story than the offline/online discussion.
Please note that the documentation shipped with the system is available online
already (on docs.kde.org).
For sure this is a broader topic (apart from the kdeconnect example), and you
could say I'm opinionated as kdoctools maintainer, but still.
Ciao
--
Luigi
More information about the kde-core-devel
mailing list