Bug 202985 - Delete outdated help files. Link to UserBase instead
Summary: Delete outdated help files. Link to UserBase instead
Status: RESOLVED INTENTIONAL
Alias: None
Product: docs.kde.org
Classification: Websites
Component: general (show other bugs)
Version: unspecified
Platform: unspecified Unspecified
: NOR normal
Target Milestone: ---
Assignee: Documentation Editorial Team
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2009-08-07 18:04 UTC by markuss
Modified: 2010-09-06 20:15 UTC (History)
1 user (show)

See Also:
Latest Commit:
Version Fixed In:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description markuss 2009-08-07 18:04:31 UTC
Version:            (using KDE 4.3.0)

Via an post on Planet GNOME I read http://lists.kde.org/?l=kde-doc-english&m=124963513220501&w=2
It's a user who was totally left in the dark by outdated information.
The (as of now) only reply advised him to user UserBase instead.
So what's the point of shipping outdated help files that contain information that's no longer applicable? Delete them altogether and make the Help menu (F1) open UserBase.
Comment 1 Burkhard Lück 2009-08-07 22:25:56 UTC
(In reply to comment #0)
> Version:            (using KDE 4.3.0)
> 
> Via an post on Planet GNOME I read
> http://lists.kde.org/?l=kde-doc-english&m=124963513220501&w=2
> It's a user who was totally left in the dark by outdated information.
> The (as of now) only reply advised him to user UserBase instead.
> So what's the point of shipping outdated help files that contain information
> that's no longer applicable? Delete them altogether and make the Help menu (F1)
> open UserBase.

I don't aggree. 

1) For the two mentioned kde related problems (show a hidden menubar, add an icon to start an application to the systray) there is no outdated documentation, there are no changes since kde 3.x to do that. The only problem I see is how to a user can find a particular information.

2) On Userbase the information is in many cases a link to the documentation on docs.kde.org. And there you find a lot of up to date documentation, that's around half of the documentation in kde's main modules.

3) Translation on a wiki is a pain and does not work well. The kde documentation in svn is translated around 10-20 times more than on userbase. As long as there is no proper way to export the wiki content into the kde translation system and import translations back to the wiki, with your suggestion you exclude all non english speaking people from the documentation.

4) This suggestion using a wiki for documentation comes again and again, if the time writing all these emails discussing this issue had been used to improve our documentation, it would be much more up to date and comprehensive.  

5) Judging from my experience since 5 years as a translator with the quality of translation via a webinterface or with one time translators, this wiki approach will end in the same way as usual: Most work will to be done by a few people like annew - btw she does a really great job. So I see no real improvement  to the current situation.
Comment 2 Vikram Dhillon 2010-01-17 03:00:56 UTC
I understand that our documentation isn't updated, but we are working on this. Currently a lot of people from the documentation team are working on keeping the documentation updated, as you see the docs. are pretty lengthy so it takes a while. Pretty soon the help files will be up-to-date.
Comment 3 Vikram Dhillon 2010-01-17 03:08:31 UTC
I understand that our documentation isn't updated, but we are working on this. Currently a lot of people from the documentation team are working on keeping the documentation updated, as you see the docs. are pretty lengthy so it takes a while. Pretty soon the help files will be up-to-date.