home *** CD-ROM | disk | FTP | other *** search
/ NetNews Usenet Archive 1992 #18 / NN_1992_18.iso / spool / comp / os / linux / 8219 < prev    next >
Encoding:
Internet Message Format  |  1992-08-14  |  1.9 KB
  1. Path: sparky!uunet!crdgw1!rdsunx.crd.ge.com!ariel!davidsen
  2. From: davidsen@ariel.crd.GE.COM (william E Davidsen)
  3. Newsgroups: comp.os.linux
  4. Subject: Re: Stabilizing linux
  5. Message-ID: <1992Aug14.133217.23937@crd.ge.com>
  6. Date: 14 Aug 92 13:32:17 GMT
  7. References: <1992Aug13.200750.1247@athena.mit.edu>
  8. Sender: usenet@crd.ge.com (Required for NNTP)
  9. Reply-To: davidsen@crd.ge.com (bill davidsen)
  10. Organization: GE Corporate R&D Center, Schenectady NY
  11. Lines: 26
  12. Nntp-Posting-Host: ariel.crd.ge.com
  13.  
  14. In article <1992Aug13.200750.1247@athena.mit.edu>, komarimf@craft.camp.clarkson.edu (Mark Komarinski) writes:
  15.  
  16. | Why not have both?  Whipping up some on-line manuals that can be printed
  17. | or viewed should not be that much trouble, and everyone will benefit in the
  18. | end.
  19.  
  20.   I think you should be the one to do it, then. I've written 40-50 page
  21. user manuals, and many programs of that size, and I can tell you that a
  22. quality manual takes about 2x longer, per page, than code. That insuring
  23. that the notation is consistent end to end, the style is uniform (chatty
  24. or dry, but consistent), that every fact is correct, exceptions are
  25. noted (this works with 0.96a and 0.96b, but not later versions), and
  26. that there are clear examples for all sections which a user could
  27. possibly misunderstand.
  28.  
  29.   My recent experience with asking for the location of docs rather than
  30. useful hints was revealing; on two questions I got a total of 31 answers
  31. (Linux people are the nicest on the net!), but I got 30 "I don't have
  32. docs, but this worked for me," and one "thaere's a doc on tsx... but
  33. it's not very clear, this is what I think it means." So I now have a few
  34. more lines of notes in my KWS notes file, but no new docs.
  35.  
  36.   This could really be a huge job, you've been warned.
  37. -- 
  38. bill davidsen, GE Corp. R&D Center; Box 8; Schenectady NY 12345
  39.     I admit that when I was in school I wrote COBOL. But I didn't compile.
  40.