home *** CD-ROM | disk | FTP | other *** search
/ NetNews Usenet Archive 1993 #1 / NN_1993_1.iso / spool / comp / sys / amiga / misc / 19622 < prev    next >
Encoding:
Internet Message Format  |  1993-01-08  |  4.8 KB
  1. Path: sparky!uunet!zaphod.mps.ohio-state.edu!cs.utexas.edu!rutgers!cbmvax!ross
  2. From: ross@cbmvax.commodore.com (Ross Hippely - Manuals)
  3. Newsgroups: comp.sys.amiga.misc
  4. Subject: Re: Commodity question
  5. Summary: Docs are stupid things...
  6. Keywords: documentation manual enforcer 2.04
  7. Message-ID: <38414@cbmvax.commodore.com>
  8. Date: 8 Jan 93 16:08:51 GMT
  9. References: <38291@cbmvax.commodore.com> <wanderer.03pd@tcsi.appleton.mil.wi.us>
  10. Reply-To: ross@cbmvax.commodore.com (Ross Hippely - Manuals)
  11. Followup-To: comp.sys.amiga.misc
  12. Organization: Commodore, West Chester, PA
  13. Lines: 92
  14.  
  15. In article <wanderer.03pd@tcsi.appleton.mil.wi.us> wanderer@tcsi.appleton.mil.wi.us (K.T. Wieringa) writes:
  16. >Ross Hippely - Manuals (ross@cbmvax.commodore.com) wrote:
  17. >: In article <wanderer.03nq@tcsi.appleton.mil.wi.us> wanderer@tcsi.appleton.mil.wi.us (K.T. Wieringa) writes:
  18.  
  19. >Another person mailed me saying that enforcer wasn't part of the OS
  20. >distribution.  It seems to have come with mine; both on the hard drive
  21. >(sys:tools) and on the install3000 disk.  I was wondering if there was 
  22. >any documentation included.  I haven't found any.
  23. >
  24. >: >Still haven't found it in the big book 
  25. >: 
  26. >: And could you refresh my memory on where in _Using the System Software_ 
  27. >: (not a new manual, by the way) Enforcer is mentioned?  
  28. >
  29. >I think that was my point.  It's part of the OS disk distribution, but the
  30. >documentation isn't?
  31.  
  32. Right.  My point was to establish whether there was any place in the docs
  33. that told you to use Enforcer.  As a rule, if it's not mentioned in the
  34. docs, you are not expected to mess with it.  (Or rather, you're *expected*
  35. to mess with it, but only at your own risk ;-)
  36.  
  37. There are lots of things that appear on disks that we give you--especially
  38. Install disks--that are necessary for some reason, but which are there to
  39. be used by another piece of software, or under certain special conditions,
  40. and which can and should be ignored by users.  I understand the temptation
  41. to try out the mystery files, and the desire to have everything documented.
  42. But believe me, if we really documented *everything* _Using the System
  43. Software_ would have needed *two* binders.
  44.  
  45. Now I won't claim that we do in fact always succeed in documenting everything
  46. you do need to know, but we try.  "If you don't know what it is, leave it
  47. alone" remains a fairly good rule to live by.  Even for Amiga folks ;-)
  48.  
  49. > As far as detailed constructive criticism goes,
  50. >
  51. > -  I'd find it real helpful if there was some kind of appendix or 
  52. >    supplement available which covered, or at least cross referenced, 
  53. >    upgrading from one OS to another.  Something for those of us who know
  54. >    the basics but would like to more easily parse the differences without
  55. >    having to wade through the simple stuff all over again.
  56.  
  57. If you upgraded to 2.0, you should have received the _Getting Started_
  58. manual, which does just that.  If you bought a system with 2.0 already on
  59. it, you wouldn't get this, but it would be much less necessary.
  60.  
  61. > -  The Index could use some work (in my opinion). [...]
  62.  
  63. I wouldn't argue with you there.  The most pertinent comment I can make is
  64. that for _UtSS_ (everything pre-2.1, actually), the index was done be hand.
  65. We now have partially automated indexing, which is much easier, hence much
  66. less likely to leave out important references.
  67.  
  68. > -  some of the requestors in the diagrams differ quite a bit in available
  69. >    options from the ones on my screen (prefs/screenmode and prefs/overscan
  70. >    are two that come to mind).
  71.  
  72. An inevitable consequence of manual development in parallel with software
  73. development.  I think we put a disclaimer up front that said "screens
  74. may differ from the illustrations" or something, in an attempt to cover
  75. ourselves. :-)
  76.  
  77. > -  how often do you really send out upgrades for this manual?  [...]
  78.  
  79. We don't really send out upgrades.  But there were one or two "change
  80. pages" inserts we created to throw in the box with the older manuals
  81. when there were significant changes.
  82.  
  83. > [...] is the looseleaf format really 
  84. > necessary?  It doesn't seem near as durable as a bound manual.  [...]
  85.  
  86. In some ways it is, in others it isn't.  People seem to be split on whether
  87. they like the binder.  We have gone to all perfect binding for large manuals
  88. now, for cost reasons.
  89.  
  90. >And we can be such picky SOB's  :-). 
  91.  
  92. No offense taken.
  93.  
  94. >I try to avoid judging on the basis of things that aren't yet available.
  95.  
  96. Good point!  At least the people buying current systems can get examples
  97. of improved manuals.
  98.  
  99. [...]
  100. > | K.T. Wieringa              UUCP: toddw@tcsi.appleton.mil.wi.us |
  101. > | Shawano, Wisconsin, USA    Fido: K.T. Wieringa @ 1:238/105.3   |
  102.  
  103. -- 
  104. ----------------------------------------------------------------------------
  105. Ross Hippely:                                               Technical Writer
  106. employed by, not speaking for:              Commodore Business Machines Inc.
  107.