Bug 128605 - [needs volunteer] improve user documentation
Summary: [needs volunteer] improve user documentation
Alias: None
Product: adept
Classification: Miscellaneous
Component: general (show other bugs)
Version: unspecified
Platform: unspecified Linux
: NOR wishlist
Target Milestone: ---
Assignee: Peter Rockai
Depends on:
Reported: 2006-06-04 10:52 UTC by Carsten Niehaus
Modified: 2013-09-21 04:44 UTC (History)
1 user (show)

See Also:
Latest Commit:
Version Fixed In:
Sentry Crash Report:


Note You need to log in before you can comment on or make changes to this bug.
Description Carsten Niehaus 2006-06-04 10:52:47 UTC
Version:           2.0 Destroyer (using KDE 3.5.3, Kubuntu Package 4:3.5.3-0ubuntu0.1 dapper)
Compiler:          Target: i486-linux-gnu
OS:                Linux (i686) release 2.6.15-23-386

Well, this is not a real bugreport, but somehow I feel I want this to be documented...
Adept improved a lot in the last year, but the version in Dapper is missing one seriously important thing: Documentation!

There is not a single QWhatThis I found
... no QToolTip
... no man-page
... no manual
... the homepage of the author is not giving any information
... http://web.ekhis.org/adept.html is dead

I installed Dapper on the computers of two others, both are users and have no clue about things like "apt", "shell" and so on. The didn't understand the concept of Adept at all and finally gave up because they found no documentation whatsoever. This if for me a showstopper-bug, nothing less.
There is no "usability"-section in this bugtracker, this is why I filed it as a wish... Adding tooltips on the 20 most important widgets would help *a lot*.
Comment 1 Peter Rockai 2008-03-09 15:58:10 UTC
Yes, well, this is true. However, I have as little time as it gets, so help with documentation would be welcome. I have been working on a 3.0 for some time now, which should address at least some of the usability issues, but there are probably quite some left, and there's still too little documentation.
Comment 2 Peter Rockai 2008-08-12 17:25:57 UTC
I believe the situation has much improved with Adept 3. However, this is mostly a perpetual issue -- I'm marking it as needs volunteer, so people are encouraged to step up with help text improvements.
Comment 3 Jekyll Wu 2013-09-21 04:44:50 UTC
Adept has been in the unmaintained state for a few years.  Use muon[1] as replacement .

[1] https://launchpad.net/muon