Documentation blues

John A Martin jam@jamux.com
Tue Jun 24 21:58:02 2003


--=-=-=
Content-Transfer-Encoding: quoted-printable

>>>>> "Robin" =3D=3D Robin Lynn Frank
>>>>> "Re: Documentation blues"
>>>>>  Tue, 24 Jun 2003 11:43:22 -0700

    Robin> On Monday 23 June 2003 06:31 pm, Ben Finney wrote:
    >> On 23-Jun-2003, Robin Lynn Frank wrote:
    >> > There must be some law I am unaware of that documentation
    >> > must be as tedious as possible
    >>
    >> Does it look like this?
    >>
    >> Frank's Law of Documentation: Documentation is either written
    >> by programmers who are too close to the program to know how to
    >> tell a user about it, or written by people who had no
    >> documentation and did everything the hard way.

    Robin> Pretty close!  What I was looking for was over 950 lines
    Robin> down in man gpg.  Laying every command and configuration
    Robin> parameter out in alphabetical order is about as useful as
    Robin> using a dictionary to learn the spelling of a word.  You
    Robin> might get lucky...or not.

http://www.catb.org/~esr/writings/taoup/html/documentationchapter.html

        jam


--=-=-=
Content-Type: application/pgp-signature

-----BEGIN PGP SIGNATURE-----

iD8DBQA++K2xUEvv1b/iXy8RAiGqAJ4oxePcpe1NIOxh0taWdVFn6FTv1gCeIhfA
TzVZp9x6S/+A9lCB9dptry8=
=xU9t
-----END PGP SIGNATURE-----
--=-=-=--