Red Hat Bugzilla – Bug 54302
Lack of documentation
Last modified: 2007-04-18 12:37:28 EDT
From Bugzilla Helper:
User-Agent: Mozilla/4.76 [en] (X11; U; Linux 2.4.2-2 i686; Nav)
Description of problem:
There is no documentation for the rp3 package. No man or info pages,
nothing in /usr/share/doc.
It took me all day to find out that the program rp3 existed. I found
rp3-config on the Gnome desktop, and spent all morning trying to get it to
play with netcfg. That does not work (something else to document).
I found the program rp3 by reading rp3-related bug reports in Bugzilla.
The documentation in the getting started guide neglects to mention that rp3
is a separate program from rp3-config, and only shows how to launch
rp3-config (incorrectly, at that).
The command line help (rp3 --help) works but is terse and insufficient. In
addition, it should refer the user to more complete documentation
I am an experience Unix and Linux user (7 years with Linux, more than 10
with Unix) and if it takes me all day and a trip to Bugzilla to learn how
to use a program, you need to do some serious usability studies.
I've been writing software for 23 years, and I document everything I do as
I do it. Come on, guys. The job isn't over until the paperwork's done.
Version-Release number of selected component (if applicable):
Steps to Reproduce:
1. Install rp3 package
2. Search for documentation in all the usual places.
Now that rp3 is gone, how much of an issue is this?
If rp3 is gone, I guess it now has an appropriate level of
documentation. As far as I am concerned, you may close this.