Bug 233220 - Docs need serious revamping
Summary: Docs need serious revamping
Status: RESOLVED FIXED
Alias: None
Product: k3b
Classification: Applications
Component: general (show other bugs)
Version: 1.91.0
Platform: unspecified All
: NOR normal
Target Milestone: 2.1
Assignee: Michał Małek
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2010-04-04 03:53 UTC by Jonathan Thomas
Modified: 2014-10-02 00:02 UTC (History)
6 users (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 Jonathan Thomas 2010-04-04 03:53:11 UTC
Version:           1.91.0 (using 4.4.2 (KDE 4.4.2), Kubuntu packages)
Compiler:          cc
OS:                Linux (i686) release 2.6.32-19-generic-pae

As it stands in K3b 1.91.0, the docs shipped with K3b haven't been touched since K3b 1.x days. The screenshots are all for KDE3, and there's even an entire section on the DCOP interface. There's also grammatically ...unique... passages such as:

" In this dialog is nothing you can do. Just wait for you computer to finish the session."

At this point, I think that it'd be better to just skip the documentation for 2.0, as the current documentation contains a lot of useless, outdated information, outdated screenshots, and generally gives off an unprofessional vibe.
Comment 1 markuss 2010-05-22 00:15:00 UTC
A student offered to revamp the documentation. Since we're in string freeze since some time, we can't change it for 2.0.
However, it's likely that we'll just link to KDE UserBase in the future and delete the DocBook-based documentation altogether.
Comment 2 Albert Astals Cid 2014-09-29 22:19:33 UTC
Doc people maybe you can help here?
Comment 3 Yuri Chornoivan 2014-09-30 04:37:11 UTC
Docs were updated back in 2011 (K3b 2.0), screenshots were updated too.

https://docs.kde.org/stable/en/extragear-multimedia/k3b/index.html