home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 8 Other / 08-Other.zip / week_1.zip / Document.txt < prev    next >
Text File  |  1996-01-01  |  88KB  |  2,089 lines

  1.  
  2. #: 69344 S20/Marketing OS/2 Apps
  3.     25-Dec-95  13:48:33
  4. Sb: #Documentation quality
  5. Fm: Esther Schindler [EXEC] 72241,1417
  6. To: Herbert Ice 72370,2501 (X)
  7.  
  8.      <<< Start new thread from # 69335-Pound Pound Pound in S20 >>>
  9.  
  10.  > How importent is printed documentation to the customer?
  11.  >
  12.  >  Expansion:
  13.  >
  14.  >  I see it as being quite importent, but not for sure that for
  15.  > certain customers, it would not be better to have the
  16.  > documentation incorporated into the diskettes in 2 or 3 formats
  17.  > (Ascii, Describe, AmiPro) such that they could print documentation
  18.  > themselves at thier leisure. Really thinking about oversees
  19.  > customers where the difference in poundage can be substantial in
  20.  > the cost of shipping the product. Also along the lines of course,
  21.  > that this could reduce the price, percentage wise quite a bit.
  22.  
  23. Online documentation works very well for some kinds of products. I think it's
  24. entirely appropriate when the nature of the product requires that there be a
  25. LOT of information to wade through, and no matter how good the indexing is,
  26. it'll never be perfect. I love having the IBM Red Books in one fat CD ROM, for
  27. instance, because when I want to look up information about CONFIG.SYS and REXX
  28. I don't want to have to wonder where I'm most likely to find it. Compiler
  29. documentation is another good example of where online documentation is
  30. valuable.
  31.  
  32. That isn't so for most general applications, though, and it's CERTAINLY not
  33. true of the mainstream market. Don't underestimate the value of reading the
  34. manual into the john. Don't discount the value of screen shots and pictures
  35. and lots of handholding.
  36.  
  37. I can tell you that the documentation quality for most OS/2 software stinks.
  38. There are some notable exceptions, but they are few and far between. (And in
  39. the good cases you *do* know who you are because I've told you so explicitly.)
  40. Too many OS/2 ISVs have the same person write the program that wrote the
  41. documentation, and that's a *terrible* thing to do; even if the programmer is
  42. a good writer (which he usually isn't) he knows too much about the product and
  43. writes with those assumptions. The reader does *not* have the same assumptions
  44. or knowledge and is often lost.
  45.  
  46. As an example, I'll pick on one ISV (who knows what I think of the current
  47. documentation because we've talked about it): Colorworks. If you already know
  48. how to use Colorworks, or if you've seen Joel demo it, the documentation makes
  49. perfect sense. However, if you have never used an image editing program before
  50. (much less one that changes the paradigms), the documentation is worthless.
  51. There's no "here's the basics" chapter, there's no tutorial. There's no video
  52. showing how to use it. When documentation is done correctly it can save the
  53. company gobs of money, because it's clear enough that the user learns how to
  54. use the program and doesn't call for tech support.
  55.  
  56. Look carefully at the documentation produced by the top-selling applications
  57. in your product area. What assumptions do they make about the user's
  58. knowledge? What tone do they write with? (Most OS/2 product manuals are dry
  59. and lifeless; good documentation is bright and cheery and friendly, like a
  60. good cookbook.) How often do they show the screen? I've seen entirely too many
  61. OS/2 product manuals that completely lacked a screen shot; there's no excuse
  62. for that. (And there's even fewer screen shots in online documentation.)
  63.  
  64. *Never* let the person who wrote the program write the documentation. And no,
  65. that doesn't mean "convince my wife to write it" either; your spouse has been
  66. too close to the project too. Get a real technical writer and don't blanch
  67. when you hear their rates.
  68.  
  69. Yes, in some cases having online documentation is the right way to go. But
  70. I've seen that used entirely too often as an excuse for doing a poor job at
  71. writing a manual.
  72.  
  73. --Esther
  74.  
  75. There are 2 Replies.
  76.  
  77.  
  78. #: 69357 S20/Marketing OS/2 Apps
  79.     25-Dec-95  23:28:29
  80. Sb: #69344-Documentation quality
  81. Fm: Herbert Ice 72370,2501
  82. To: Esther Schindler [EXEC] 72241,1417
  83.  
  84. Esther,
  85.  
  86.  Let me say first off, that I do believe in documentation, having waded
  87. through IBM 370, 4341, 390 PoPs I know good doc when I see it<g>, of course
  88. that does not mean that I can write it(unforunatly).
  89.  
  90.  Personally I would not consider a software product unless it had both online,
  91. and hardcopy doc, as I do believe in the power of the john<g>. Most of my
  92. question really centers around, "does the documentation have to arrive in a
  93. hardcopy with the package, or can it arrive in a fashion that the consumer can
  94. print it out as they see fit?
  95.  
  96.  Actually I think the documentation stinks for most products, whether OS/2 or
  97. not. I will have to defend IBM documentation (mainframe), in that the PoPs I
  98. always found to be very good, although I would imagine that came from years of
  99. experience. I also think that the documentation that comes with Rexx for the
  100. VM enviroment is the best I have ever seen, in that it proceeds in 3 phases,
  101. where you go through the users manual 3 different times, building upon what
  102. was done the prior pass for that particular chapter. This does not restrict
  103. you from reading cover to cover, but following the manual helps unfold Rexx
  104. like peeling an onion. Or if you will the way most of us learn, I think.
  105.  
  106.  Unfortunatly, our product does not have this capability ( in some areas it
  107. does) of progressive learning, one must comprehend it all, or nothing.
  108. Fortunatly this is limited to the IDE, SCSI, and PCI sections. For those
  109. sections I do not want to just retype the relevant tech. spec. (besides
  110. copyright problems). This is an area that I have wrestled with quite a bit. I
  111. seam to be able to explain to customers over the phone what certain portions
  112. of the SCSI spec mean to them, and thier business, so I have defaulted to
  113. typing in the first person in that section of the online doc. Do you feel that
  114. is appropriate?
  115.  
  116.  I would agree that the person writing the code is too close to the product,
  117. to write decent documentation, alas in my case this will have to be done for
  118. the first go around. Then pass the doc through a technical writer ( I know a
  119. fine tech writer back in VA) for the second pass. As in my experience, I can
  120. get the technical parts down, but the tech writer, raises questions that I
  121. would never think of.
  122.  
  123.  When you refer to "here's the basics", the first question I have coming back
  124. to you is, "How basic is basic?". Let's take the area of hard drive
  125. performance (in certain area's I am about to give up on basics, such as the
  126. Process Information), does one have to start at the "This is a track, This is
  127. a head, they comprise a cylynder ..." level. Or is this more a question of the
  128. target audience?
  129.  
  130.  As to screen shots, when I upload the IWSS.INF book here to Compuserve, every
  131. screen that the product produces is included, this has had the effect of
  132. adding hundreds of megabytes to the size of the INF, hence there will be two,
  133. one with, and one without, such that folks can download the little one, and
  134. get a flavor of what the product does at little cost, if there is further
  135. interest, they can then download the monster. I see this as helping in a
  136. couple of ways.
  137.  
  138.  1. informed purchase by the consumer. Such that I am attempting to alleviate
  139. posts on the online services of "I didn't know that this product acted in this
  140. ridiculous fashion".
  141.  
  142.  2. informed purchase by the customer. If they see the ENTIRE product prior to
  143. purchase, I hope they will know whether it fits thier needs or not. This
  144. should reduce thier expense and mine.
  145.  
  146.  So my thesis is, show the online information to any and all that desire to
  147. see the product. Talk about what it does, and DOES NOT do, and proceed from
  148. that point.
  149.  
  150.  My greatest fear at this point is that the product is too technical, only
  151. time will tell.
  152.  
  153.  
  154.  Jay Ice
  155.  Iceware Inc.
  156.  
  157.  
  158. #: 69386 S20/Marketing OS/2 Apps
  159.     26-Dec-95  11:28:43
  160. Sb: #69357-#Documentation quality
  161. Fm: Esther Schindler [EXEC] 72241,1417
  162. To: Herbert Ice 72370,2501 (X)
  163.  
  164.  > Most of my question really centers around, "does the documentation
  165.  > have to arrive in a hardcopy with the package, or can it arrive in
  166.  > a fashion that the consumer can print it out as they see fit?
  167.  
  168. I'd avoid a product that required me to print it out myself. In my eyes, it
  169. cheapens the product quality. I think of the "print it yourself" manuals as
  170. belonging to unregistered shareware; even good shareware packages will send
  171. you a printed manual when you register. (You don't have to create an enormous
  172. manual; let it be the size it needs to be, and no more than that.)
  173.  
  174. In regard to "how basic?" I recommend you dig up a copy of the manual that
  175. shipped with the original Spinrite. The first chapter gave a very basic, very
  176. broad overview about how hard disks work; an expert could easily skip it but I
  177. suspect that most people learned something from it. (It had a great expanation
  178. of hard disk sectors, as I recall... and geez, I'm recalling something from a
  179. manual I read 6+ years ago!)
  180.  
  181. Hmm, I should throw in a few other examples of what I think of as "good
  182. documentation" that you (and lurkers) should pay attention to.
  183.  
  184. -- The manual for WordPerfect 4.0 and 4.1 (They changed its nature thereafter)
  185. which was so in tune with its users that it had *pictures* of the function
  186. keys that should be pressed.
  187.  
  188. -- The tutorial for Arts & Letters 1.0, which (unlike many  tutorials in which
  189. I felt that I was in a competition with myself for "how soon can I click on
  190. all these keys?") made me feel at the end that I actually _knew_ the basics of
  191. how to use the product.
  192.  
  193. -- CA Simply Accounting had a good manual. The product stank, but the manual
  194. did a very good job of describing how the product worked.
  195.  
  196.  > I have defaulted to typing in the first person in that section of
  197.  > the online doc. Do you feel that is appropriate?
  198.  
  199. Absolutely. Some publications really avoid writing in the first person (notice
  200. that Computer Shopper always said, "We looked at the motherboard..." as if a
  201. bunch of people were peering at the thing rather than one guy tearing apart
  202. the machine in his spare room) but I find it personal. I much prefer the
  203. first-person approach (you and I) to the impersonal "The user should type..."
  204. Actually, I try hard to keep person-ness out of the discussion; I'll say,
  205. "Press the space bar" rather than "You should press the space bar" or the
  206. yucky "the user should press the space bar."
  207.  
  208. Rather than upload the file with the entire documentation, I'd pick three
  209. screen shots and upload them in a ZIP file. You should be able to pick three
  210. representative shots that show what your product can do; few people want to
  211. know *everything* ahead of time... they just want to know why they should buy
  212. it.
  213.  
  214. --Esther
  215.  
  216. --Esther
  217.  
  218. There are 3 Replies.
  219.  
  220.  
  221. #: 69389 S20/Marketing OS/2 Apps
  222.     26-Dec-95  12:37:03
  223. Sb: #69386-#Documentation quality
  224. Fm: Michel Slivitzky 75726,243
  225. To: Esther Schindler [EXEC] 72241,1417 (X)
  226.  
  227. First an introduction. I am not a developer, just a plain user (and lurker)
  228. who switched to OS/2, from plain old DOS, exactly two years ago. Now running
  229. mostly OS/2 applicaations, 3-4 DOS programs and 1-2 windows programs.
  230.  
  231.  > I'd avoid a product that required me to print it out myself. In my
  232.  > eyes, it cheapens the product quality. I think of the "print it
  233.  > yourself" manuals as belonging to unregistered shareware; even
  234.  > good shareware packages will send you a printed manual when you
  235.  > register. (You don't have to create an enormous manual; let it be
  236.  > the size it needs to be, and no more than that.)
  237.  
  238. I could not agree more; I hate having to print the manuals. The manual for
  239. Mesa2 in PS format comes to something like 400 pages !!!
  240.  
  241. Speaking about manuals, besides the "how to do it" aspect, authors (or
  242. writers) should not forget to cover the "what can be done" aspect. Maybe most
  243. standard products (spreadsheet, word processors) do not need it. However some
  244. of the new aspects should be underestimated; when I moved for instance to
  245. Describe the first manual was a pain (mainly telling how to click); the one
  246. that came with version 5.0 was a "godsend" for really learning about the
  247. product.
  248.  
  249. However number of special programs I have on my system (like DevTech, Unimaint
  250. etc) would certainly benefit from good "what can be done" sections. I feel
  251. that I am lost and probably using less than 5% of the possibilities. Once you
  252. know (or at least have an idea) of what can be done you can search the online
  253. help (if properly done) for the "how to do it" aspect.
  254.  
  255. IMHO the manuals ar one of the weakest points of OS/2 packages. Even something
  256. like Lotus 1-2-3 (release 2 - for OS/2) manual is practically useless. I can
  257. count the "good" ones on the fingers of a single hand.
  258.  
  259.  
  260.  
  261.  
  262.  
  263. Michel from Quebec City, Canada <michels@uquebec.ca>
  264.  using Warp and GCP 2.22
  265.  
  266.  
  267. There is 1 Reply.
  268.  
  269.  
  270. #: 69435 S20/Marketing OS/2 Apps
  271.     26-Dec-95  19:40:18
  272. Sb: #69389-Documentation quality
  273. Fm: Esther Schindler [EXEC] 72241,1417
  274. To: Michel Slivitzky 75726,243 (X)
  275.  
  276. Good point! When I talk to developers on the phone, they always tell me about
  277. the neat feature that I can access with double alt-click metaboogie. But it's
  278. too easy for the developer (that is, you folks) to get involved with
  279. *features* and not solutions. Users buy solutions to their problems, _not_
  280. software.
  281.  
  282. When you write documentation, give people a sense of what can be done with the
  283. product. Give the basics, first -- ideally, three examples of each important
  284. feature. But also make sure people know what's possible to accomplish. Much as
  285. I hate to give credit to Corel, every year they put out a stunning book of
  286. artwork done with Corel, and they run a contest for Corel artists. You can
  287. look through the book and say, "Wow, I could do that...?!"
  288.  
  289. --Esther
  290.  
  291.  
  292. #: 69344 S20/Marketing OS/2 Apps
  293.     25-Dec-95  13:48:33
  294. Sb: #Documentation quality
  295. Fm: Esther Schindler [EXEC] 72241,1417
  296. To: Herbert Ice 72370,2501 (X)
  297.  
  298.      <<< Start new thread from # 69335-Pound Pound Pound in S20 >>>
  299.  
  300.  > How importent is printed documentation to the customer?
  301.  >
  302.  >  Expansion:
  303.  >
  304.  >  I see it as being quite importent, but not for sure that for
  305.  > certain customers, it would not be better to have the
  306.  > documentation incorporated into the diskettes in 2 or 3 formats
  307.  > (Ascii, Describe, AmiPro) such that they could print documentation
  308.  > themselves at thier leisure. Really thinking about oversees
  309.  > customers where the difference in poundage can be substantial in
  310.  > the cost of shipping the product. Also along the lines of course,
  311.  > that this could reduce the price, percentage wise quite a bit.
  312.  
  313. Online documentation works very well for some kinds of products. I think it's
  314. entirely appropriate when the nature of the product requires that there be a
  315. LOT of information to wade through, and no matter how good the indexing is,
  316. it'll never be perfect. I love having the IBM Red Books in one fat CD ROM, for
  317. instance, because when I want to look up information about CONFIG.SYS and REXX
  318. I don't want to have to wonder where I'm most likely to find it. Compiler
  319. documentation is another good example of where online documentation is
  320. valuable.
  321.  
  322. That isn't so for most general applications, though, and it's CERTAINLY not
  323. true of the mainstream market. Don't underestimate the value of reading the
  324. manual into the john. Don't discount the value of screen shots and pictures
  325. and lots of handholding.
  326.  
  327. I can tell you that the documentation quality for most OS/2 software stinks.
  328. There are some notable exceptions, but they are few and far between. (And in
  329. the good cases you *do* know who you are because I've told you so explicitly.)
  330. Too many OS/2 ISVs have the same person write the program that wrote the
  331. documentation, and that's a *terrible* thing to do; even if the programmer is
  332. a good writer (which he usually isn't) he knows too much about the product and
  333. writes with those assumptions. The reader does *not* have the same assumptions
  334. or knowledge and is often lost.
  335.  
  336. As an example, I'll pick on one ISV (who knows what I think of the current
  337. documentation because we've talked about it): Colorworks. If you already know
  338. how to use Colorworks, or if you've seen Joel demo it, the documentation makes
  339. perfect sense. However, if you have never used an image editing program before
  340. (much less one that changes the paradigms), the documentation is worthless.
  341. There's no "here's the basics" chapter, there's no tutorial. There's no video
  342. showing how to use it. When documentation is done correctly it can save the
  343. company gobs of money, because it's clear enough that the user learns how to
  344. use the program and doesn't call for tech support.
  345.  
  346. Look carefully at the documentation produced by the top-selling applications
  347. in your product area. What assumptions do they make about the user's
  348. knowledge? What tone do they write with? (Most OS/2 product manuals are dry
  349. and lifeless; good documentation is bright and cheery and friendly, like a
  350. good cookbook.) How often do they show the screen? I've seen entirely too many
  351. OS/2 product manuals that completely lacked a screen shot; there's no excuse
  352. for that. (And there's even fewer screen shots in online documentation.)
  353.  
  354. *Never* let the person who wrote the program write the documentation. And no,
  355. that doesn't mean "convince my wife to write it" either; your spouse has been
  356. too close to the project too. Get a real technical writer and don't blanch
  357. when you hear their rates.
  358.  
  359. Yes, in some cases having online documentation is the right way to go. But
  360. I've seen that used entirely too often as an excuse for doing a poor job at
  361. writing a manual.
  362.  
  363. --Esther
  364.  
  365. There are 2 Replies.
  366.  
  367.  
  368. #: 69363 S20/Marketing OS/2 Apps
  369.     26-Dec-95  04:11:45
  370. Sb: #69344-Documentation quality
  371. Fm: Samuel G. Little 70544,10
  372. To: Esther Schindler [EXEC] 72241,1417
  373.  
  374. PMJI, Esther, but I think there are a few other things to consider: the
  375. capabilities / needs of the target audience, and the type of application.
  376.  
  377. Programming languages are as good an example of the latter point as any. Being
  378. of the "old school" of programmers, I will typically use paper and pencil to
  379. work out the general structure of my programs (e.g., I start with pseudocode),
  380. then try to iron out what functions or macros I need to use. For most of this
  381. process, I don't find the computer as convenient a medium as a printed book or
  382. manual. This is one of the reasons I printed the Rexx documentation.
  383.  
  384. Most of my programs have a target audience of 15: ten computer operations
  385. staff and the other five programmers in my group. Now, none of the CompOps
  386. staff are terribly familiar with OS/2 (let alone the programmers!), and a few
  387. have basic conceptual difficulties with the WPS interface, despite my best
  388. efforts to explain (context menus are the hardest to deal with).
  389.  
  390. About half of them can *only* deal with step-by-step instructions. Any sort of
  391. error which isn't documented, with instructions on what to do next, and I get
  392. phone calls in the wee hours. I walk them through the solution, ask them to
  393. write down the error message(s) and put it in my mailbox, and I spend my first
  394. two hours when I come in in the morning updating and reprinting the
  395. documentation. (BTW, for the OS/2 stuff, I do use screen and window shots).
  396. It's been found that on-line documentation doesn't work very well for this
  397. "audience" through other systems that they have to support.
  398.  
  399. Some people -- and situations -- just aren't suited for on-line or print-only
  400. documentation.
  401.  
  402.   --Sam. (Warped & using GCP 2.20c)
  403.     sam_little@iacnet.com
  404.  
  405.  
  406. #: 69387 S20/Marketing OS/2 Apps
  407.     26-Dec-95  11:28:44
  408. Sb: #69363-Documentation quality
  409. Fm: Esther Schindler [EXEC] 72241,1417
  410. To: Samuel G. Little 70544,10 (X)
  411.  
  412. Good point, Sam!
  413.  
  414. (And *never* apologize for jumping in. The purpose of this conversation is to
  415. involve several people; if we wanted it to be private, we'd be in email.
  416. <smile>)
  417.  
  418. --Esther
  419.  
  420.  
  421. #: 69344 S20/Marketing OS/2 Apps
  422.     25-Dec-95  13:48:33
  423. Sb: #Documentation quality
  424. Fm: Esther Schindler [EXEC] 72241,1417
  425. To: Herbert Ice 72370,2501 (X)
  426.  
  427.      <<< Start new thread from # 69335-Pound Pound Pound in S20 >>>
  428.  
  429.  > How importent is printed documentation to the customer?
  430.  >
  431.  >  Expansion:
  432.  >
  433.  >  I see it as being quite importent, but not for sure that for
  434.  > certain customers, it would not be better to have the
  435.  > documentation incorporated into the diskettes in 2 or 3 formats
  436.  > (Ascii, Describe, AmiPro) such that they could print documentation
  437.  > themselves at thier leisure. Really thinking about oversees
  438.  > customers where the difference in poundage can be substantial in
  439.  > the cost of shipping the product. Also along the lines of course,
  440.  > that this could reduce the price, percentage wise quite a bit.
  441.  
  442. Online documentation works very well for some kinds of products. I think it's
  443. entirely appropriate when the nature of the product requires that there be a
  444. LOT of information to wade through, and no matter how good the indexing is,
  445. it'll never be perfect. I love having the IBM Red Books in one fat CD ROM, for
  446. instance, because when I want to look up information about CONFIG.SYS and REXX
  447. I don't want to have to wonder where I'm most likely to find it. Compiler
  448. documentation is another good example of where online documentation is
  449. valuable.
  450.  
  451. That isn't so for most general applications, though, and it's CERTAINLY not
  452. true of the mainstream market. Don't underestimate the value of reading the
  453. manual into the john. Don't discount the value of screen shots and pictures
  454. and lots of handholding.
  455.  
  456. I can tell you that the documentation quality for most OS/2 software stinks.
  457. There are some notable exceptions, but they are few and far between. (And in
  458. the good cases you *do* know who you are because I've told you so explicitly.)
  459. Too many OS/2 ISVs have the same person write the program that wrote the
  460. documentation, and that's a *terrible* thing to do; even if the programmer is
  461. a good writer (which he usually isn't) he knows too much about the product and
  462. writes with those assumptions. The reader does *not* have the same assumptions
  463. or knowledge and is often lost.
  464.  
  465. As an example, I'll pick on one ISV (who knows what I think of the current
  466. documentation because we've talked about it): Colorworks. If you already know
  467. how to use Colorworks, or if you've seen Joel demo it, the documentation makes
  468. perfect sense. However, if you have never used an image editing program before
  469. (much less one that changes the paradigms), the documentation is worthless.
  470. There's no "here's the basics" chapter, there's no tutorial. There's no video
  471. showing how to use it. When documentation is done correctly it can save the
  472. company gobs of money, because it's clear enough that the user learns how to
  473. use the program and doesn't call for tech support.
  474.  
  475. Look carefully at the documentation produced by the top-selling applications
  476. in your product area. What assumptions do they make about the user's
  477. knowledge? What tone do they write with? (Most OS/2 product manuals are dry
  478. and lifeless; good documentation is bright and cheery and friendly, like a
  479. good cookbook.) How often do they show the screen? I've seen entirely too many
  480. OS/2 product manuals that completely lacked a screen shot; there's no excuse
  481. for that. (And there's even fewer screen shots in online documentation.)
  482.  
  483. *Never* let the person who wrote the program write the documentation. And no,
  484. that doesn't mean "convince my wife to write it" either; your spouse has been
  485. too close to the project too. Get a real technical writer and don't blanch
  486. when you hear their rates.
  487.  
  488. Yes, in some cases having online documentation is the right way to go. But
  489. I've seen that used entirely too often as an excuse for doing a poor job at
  490. writing a manual.
  491.  
  492. --Esther
  493.  
  494. There are 2 Replies.
  495.  
  496.  
  497. #: 69426 S20/Marketing OS/2 Apps
  498.     26-Dec-95  17:40:10
  499. Sb: #69344-#Documentation quality
  500. Fm: Felix Cruz 72274,3102
  501. To: Esther Schindler [EXEC] 72241,1417 (X)
  502.  
  503. Esther,
  504.  
  505. Your points about documentation are noted.
  506.  
  507. I usually load a program and then try to use it without reading the docs
  508. (don't most end users do this? ;-) )
  509.  
  510. I agree the supporting manual should be clearly written, with a "how-to"
  511. section, supporting screen shots, as well as an introduction into the
  512. product's capabilities. We plan to revise the product manuals as each goes
  513. through its product cycles to orient them from the perspective of a casual,
  514. unsophisticated user.
  515.  
  516. Although most people won't read them, a product's manual *does* add value to
  517. the product, so we will continue to include them.
  518.  
  519.  
  520.  
  521.  
  522. Felix Cruz
  523.  SofTouch Systems, Inc
  524.  
  525.  
  526. There are 2 Replies.
  527.  
  528.  
  529. #: 69433 S20/Marketing OS/2 Apps
  530.     26-Dec-95  19:26:43
  531. Sb: #69426-#Documentation quality
  532. Fm: Michel Slivitzky 75726,243
  533. To: Felix Cruz 72274,3102 (X)
  534.  
  535.  > Although most people won't read them, a product's manual *does*
  536.  > add value to the product, so we will continue to include them.
  537.  
  538. I read  all manuals that I have for SofTouch products (three of them); they
  539. are good even if the one for Unimaint is somewhat "light" IMHO on the "What
  540. can be done" aspect. There are so many things that can be done with it; I
  541. probably missed about 70% of them.
  542.  
  543.  
  544.  
  545.  
  546.  
  547. Michel from Quebec City, Canada <michels@uquebec.ca>
  548.  using Warp and GCP 2.22
  549.  
  550.  
  551. There is 1 Reply.
  552.  
  553.  
  554. #: 69452 S20/Marketing OS/2 Apps
  555.     27-Dec-95  00:11:52
  556. Sb: #69433-Documentation quality
  557. Fm: Felix Cruz 72274,3102
  558. To: Michel Slivitzky 75726,243 (X)
  559.  
  560. Michel,
  561.  
  562. Thanks for letting us know how useful the product manuals are to you. We will
  563. continue to enhance them by adding more in the "how-to" area.
  564.  
  565. The relevant point to the discussion here is that manuals can always be
  566. improved upon, and they are an essential component of a successful product.
  567.  
  568.  
  569.  
  570. Felix Cruz
  571.  SofTouch Systems, Inc
  572.  
  573.  
  574. #: 69386 S20/Marketing OS/2 Apps
  575.     26-Dec-95  11:28:43
  576. Sb: #69357-#Documentation quality
  577. Fm: Esther Schindler [EXEC] 72241,1417
  578. To: Herbert Ice 72370,2501 (X)
  579.  
  580.  > Most of my question really centers around, "does the documentation
  581.  > have to arrive in a hardcopy with the package, or can it arrive in
  582.  > a fashion that the consumer can print it out as they see fit?
  583.  
  584. I'd avoid a product that required me to print it out myself. In my eyes, it
  585. cheapens the product quality. I think of the "print it yourself" manuals as
  586. belonging to unregistered shareware; even good shareware packages will send
  587. you a printed manual when you register. (You don't have to create an enormous
  588. manual; let it be the size it needs to be, and no more than that.)
  589.  
  590. In regard to "how basic?" I recommend you dig up a copy of the manual that
  591. shipped with the original Spinrite. The first chapter gave a very basic, very
  592. broad overview about how hard disks work; an expert could easily skip it but I
  593. suspect that most people learned something from it. (It had a great expanation
  594. of hard disk sectors, as I recall... and geez, I'm recalling something from a
  595. manual I read 6+ years ago!)
  596.  
  597. Hmm, I should throw in a few other examples of what I think of as "good
  598. documentation" that you (and lurkers) should pay attention to.
  599.  
  600. -- The manual for WordPerfect 4.0 and 4.1 (They changed its nature thereafter)
  601. which was so in tune with its users that it had *pictures* of the function
  602. keys that should be pressed.
  603.  
  604. -- The tutorial for Arts & Letters 1.0, which (unlike many  tutorials in which
  605. I felt that I was in a competition with myself for "how soon can I click on
  606. all these keys?") made me feel at the end that I actually _knew_ the basics of
  607. how to use the product.
  608.  
  609. -- CA Simply Accounting had a good manual. The product stank, but the manual
  610. did a very good job of describing how the product worked.
  611.  
  612.  > I have defaulted to typing in the first person in that section of
  613.  > the online doc. Do you feel that is appropriate?
  614.  
  615. Absolutely. Some publications really avoid writing in the first person (notice
  616. that Computer Shopper always said, "We looked at the motherboard..." as if a
  617. bunch of people were peering at the thing rather than one guy tearing apart
  618. the machine in his spare room) but I find it personal. I much prefer the
  619. first-person approach (you and I) to the impersonal "The user should type..."
  620. Actually, I try hard to keep person-ness out of the discussion; I'll say,
  621. "Press the space bar" rather than "You should press the space bar" or the
  622. yucky "the user should press the space bar."
  623.  
  624. Rather than upload the file with the entire documentation, I'd pick three
  625. screen shots and upload them in a ZIP file. You should be able to pick three
  626. representative shots that show what your product can do; few people want to
  627. know *everything* ahead of time... they just want to know why they should buy
  628. it.
  629.  
  630. --Esther
  631.  
  632. --Esther
  633.  
  634. There are 3 Replies.
  635.  
  636.  
  637. #: 69403 S20/Marketing OS/2 Apps
  638.     26-Dec-95  13:46:04
  639. Sb: #69386-#Documentation quality
  640. Fm: Herbert Ice 72370,2501
  641. To: Esther Schindler [EXEC] 72241,1417 (X)
  642.  
  643. Esther,
  644.  
  645.   >  (You don't have to create an enormous manual; let it be the size
  646.  > it needs to be, and no more than that.)
  647.  
  648.  The above is the nut of the problem, to be done right, it could easily hit
  649. 200+ pages. I mean how big is the relevant portions of the Scsi-II spec, IDE
  650. spec, Internals of OS/2, how can settings of the config.sys impact one of the
  651. performance benchmarks?
  652.  
  653.  I don't feel that I can upload just 3 screen shots, that is too low of a
  654. percentage of the windows, and not representative of the functionality of the
  655. product.
  656.  
  657.  
  658.  Jay Ice
  659.  Iceware Inc.
  660.  
  661.  
  662. There is 1 Reply.
  663.  
  664.  
  665. #: 69436 S20/Marketing OS/2 Apps
  666.     26-Dec-95  19:40:21
  667. Sb: #69403-Documentation quality
  668. Fm: Esther Schindler [EXEC] 72241,1417
  669. To: Herbert Ice 72370,2501 (X)
  670.  
  671. I think the confusion on "how much documentation" here stems from the
  672. definition you have for "who is your user?"
  673.  
  674. You have permission to read ahead in the book, Jay -- skip ahead to chapter 4
  675. and read through the section entitled "Sample Scenario."
  676.  
  677. I don't think you're writing your application for my next door neighbor, the
  678. nice sweet lady who called me yesterday afternoon to ask me to help her
  679. install Myst. (She didn't know that her CD ROM drive had a letter associated
  680. with it. "Type E colon backslash... no the OTHER slash...") Just as Spinrite
  681. was aimed at and successful with techies, so will your audience be -- at least
  682. in the first version. Give THOSE people the basics of what they need to know
  683. to intelligently use your product. How much do I need to know about the SCSI
  684. spec in order to get the most out of the product? Tell me that much, and not
  685. much more.
  686.  
  687.  >  I don't feel that I can upload just 3 screen shots, that is too
  688.  > low of a percentage of the windows, and not representative of the
  689.  > functionality of the product.
  690.  
  691. If that's so, then you have a serious problem in the design of the product. I
  692. can tell you already that as a reviewer you'd get a *maximum* of three screen
  693. shots in an in-depth review, and probably only one. If it helps you any...
  694. which three screens would you wish I'd choose to include? Use those. (You may
  695. "cheat" and look at reviews of products you know well... and try to figure out
  696. why the reviewer included the screen shots she did.)
  697.  
  698. --Esther
  699.  
  700.  
  701. #: 69477 S20/Marketing OS/2 Apps
  702.     27-Dec-95  12:28:08
  703. Sb: #69436-#Documentation quality
  704. Fm: Herbert Ice 72370,2501
  705. To: Esther Schindler [EXEC] 72241,1417 (X)
  706.  
  707. Esther,
  708.  
  709.  No, it's not for your neighbor, to use on a daily basis, why the product is
  710. for your nieghbor, is that while very few people are truly professional
  711. carpenters/mechanics I'll bet dollars to donuts (or even chocolate for that
  712. matter<g>). That most folks do have a hammer or screwdriver in thier
  713. possesion. This is the analogy that I draw when folks question why they would
  714. need it. No you may not understand everything (although if the doc is written
  715. correctly that can be PARTIALLY aleviated), but when you don't I'll bet that
  716. you call someone who you feel does, now you can give them the information
  717. easily, even down to the point of inspecting I/O ports without writing one
  718. line of code (don't snicker it can be helpfull when looking at IDE hard
  719. drives<G>). I may have missed the boat totally, only time can tell. In general
  720. it will be the power user and above that gravitates to the product though.
  721.  
  722.  A reviewer could quite easily pick out 3 different screen shots, what I was
  723. thinking when I wrote that, was along the lines of there is a lot in this, and
  724. to distill it down to 3 shots, somehow feels like cutting the products throat,
  725. a reviewer would not have that egotistical problem, which I do. As to the 3
  726. screens a reviewer would choose it would depend on the periodical. For OS/2
  727. magazine, the opening screen (as it shows all the chiseled buttons for
  728. invoking every function), the multitasking command line, then probably the
  729. performance stuff (of course that is 3 main windows in and of itself). For
  730. IBM's journal, the main, scsi, IRQ usage, would be the flavor that I would
  731. want to represent.
  732.  
  733.  
  734.  Jay Ice
  735.  Iceware Inc.
  736.  
  737.  
  738. There is 1 Reply.
  739.  
  740.  
  741. #: 69509 S20/Marketing OS/2 Apps
  742.     27-Dec-95  20:29:26
  743. Sb: #69477-Documentation quality
  744. Fm: Esther Schindler [EXEC] 72241,1417
  745. To: Herbert Ice 72370,2501
  746.  
  747. I think you're still being unclear about who will buy your product. The answer
  748. could be as simple as, "The same people who purchase Gammatech Utilities or
  749. Partition Magic" (in which case you find yourself with a _really_ good clue
  750. about partnering for effective cooperative marketing), or as complex as
  751. "Anyone who needs to manage or maintain OS/2 systems to the peak of their
  752. performance."
  753.  
  754. In other words, I'm trying to get you to define, explicitly, who will USE your
  755. program.
  756.  
  757. The second step is to define who will _buy_ the product which (as can be
  758. easily demonstrated in a corporate environment) might be a very different
  759. answer.
  760.  
  761. You're going to start out with power users. EVERYONE starts out with the early
  762. adopters... or they wouldn't be called early adopters, now would they? <grin>
  763. So design your message to appeal to them (the people who own _lots_ of
  764. screwdrivers, not to mention a model train set, a complex kitchen gadget, and
  765. a ham radio setup), but keep in mind that the eventual audience is much
  766. bigger.
  767.  
  768. Norton Utilities' marketing really is a good model for you; originally it was
  769. for the techies, but eventually it was marketed as the *lifesaver,* the tool
  770. to have around if you're afraid of what could happen. I'm sure that plenty of
  771. packages were purchased and never used, like kitchen fire extinguishers. But
  772. notice the distinction between the early market (people who liked to muck
  773. about with their boot records), the mainstream market (people who want the
  774. security of a spare tire in the trunk) to the eventual use with the laggards
  775. (subset of utilities bundled with the OS and thus invisible to the user).
  776.  
  777.  > to distill it down to 3 shots, somehow feels like cutting the
  778.  > products throat
  779.  
  780. Jay, you _must_ find a way to do this. If for no other reason, if *you* don't
  781. find a way to express the product's purpose in two sentences or less (and 3
  782. screen shots or less) than other people will. A good part of what PR is really
  783. about is defining the message you want people to get in their heads about your
  784. company and your product. If you don't create an image, others will create it
  785. for you... and that image might or might not be one that you'd choose.
  786.  
  787. Your first effort was good (though I rarely show the opening screen for
  788. anything <grin>). Now improve it. <smile>
  789.  
  790. --Esther
  791.  
  792.  
  793. #: 69630 S20/Marketing OS/2 Apps
  794.     28-Dec-95  23:54:46
  795. Sb: #69509-Documentation quality
  796. Fm: Herbert Ice 72370,2501
  797. To: Esther Schindler [EXEC] 72241,1417
  798.  
  799. Esther,
  800.  
  801.   > I think you're still being unclear about who will buy your product.
  802.  
  803.  You are most correct, as I am quite unsure who will actually USE the product
  804. to it's full potential. Some days I feel that only OEMs could, but somehow it
  805. feels that I have distilled enough of the technical stuff down to a somewhat
  806. usable interface, that anyone who cares about the main features will.
  807.  
  808.  As to who will BUY the product, that for me is quite simple, technical
  809. people, pure and simple. It was never designed to be a pretty or cutesy, it
  810. was designed to give me answers to questions that I have had about computers
  811. since becoming a VM systems programmer. Running scenerios to see how things
  812. change etc. So to sum it up, it will be technical folks in the beggining who
  813. desire answers or at least closer approximations to answers than what they can
  814. get today.
  815.  
  816.  I agree on the Norton utilites, and with the evolution of same.
  817.  
  818.  To sum the product up in two sentences or less, just being a hick from the
  819. sticks, I would say,
  820.  
  821.  To learn, to improve, to save your ass!!!<g>.
  822.  
  823.  Well I am being a donkey with the last noun, but the above three phrases do
  824. sum it up for me.
  825.  Esther thank you ever so much for making me think about these things.
  826.  
  827.  
  828.  Jay Ice
  829.  Iceware Inc.
  830.  
  831.  
  832. #: 69704 S20/Marketing OS/2 Apps
  833.     29-Dec-95  22:28:20
  834. Sb: #69630-#Documentation quality
  835. Fm: Buck Bohac 70670,2352
  836. To: Herbert Ice 72370,2501 (X)
  837.  
  838. Hi Jay,
  839.  
  840.  > As to who will BUY the product, that for me is quite simple,
  841.  > technical people, pure and simple. It was never designed to be a
  842.  > pretty or cutesy, it was designed to give me answers to questions
  843.  > that I have had about computers since becoming a VM systems
  844.  > programmer.
  845.  
  846. One quick thought.  I have NEVER seen or heard a technical person complain
  847. that an application or procedure was too easy to implement or use.  On the
  848. other hand ...!
  849.  
  850. Buck
  851.  
  852. There is 1 Reply.
  853.  
  854.  
  855. #: 69725 S20/Marketing OS/2 Apps
  856.     30-Dec-95  00:55:35
  857. Sb: #69704-Documentation quality
  858. Fm: Herbert Ice 72370,2501
  859. To: Buck Bohac 70670,2352
  860.  
  861. Buck,
  862.  
  863.  Agreed, but I have heard plenty of technical people complain about tools that
  864. lacked depth, that while they were purported/hyped to be the last thing they
  865. ever needed, it never even got close. By pretty and cutesy, I am referring to
  866. a lot of fancy graphics, I have only used standard PM controls, trying to get
  867. the information out first, the michelangelos can follow.
  868.  
  869.  
  870.  Jay Ice
  871.  Iceware Inc.
  872.  
  873.  
  874. #: 69386 S20/Marketing OS/2 Apps
  875.     26-Dec-95  11:28:43
  876. Sb: #69357-#Documentation quality
  877. Fm: Esther Schindler [EXEC] 72241,1417
  878. To: Herbert Ice 72370,2501 (X)
  879.  
  880.  > Most of my question really centers around, "does the documentation
  881.  > have to arrive in a hardcopy with the package, or can it arrive in
  882.  > a fashion that the consumer can print it out as they see fit?
  883.  
  884. I'd avoid a product that required me to print it out myself. In my eyes, it
  885. cheapens the product quality. I think of the "print it yourself" manuals as
  886. belonging to unregistered shareware; even good shareware packages will send
  887. you a printed manual when you register. (You don't have to create an enormous
  888. manual; let it be the size it needs to be, and no more than that.)
  889.  
  890. In regard to "how basic?" I recommend you dig up a copy of the manual that
  891. shipped with the original Spinrite. The first chapter gave a very basic, very
  892. broad overview about how hard disks work; an expert could easily skip it but I
  893. suspect that most people learned something from it. (It had a great expanation
  894. of hard disk sectors, as I recall... and geez, I'm recalling something from a
  895. manual I read 6+ years ago!)
  896.  
  897. Hmm, I should throw in a few other examples of what I think of as "good
  898. documentation" that you (and lurkers) should pay attention to.
  899.  
  900. -- The manual for WordPerfect 4.0 and 4.1 (They changed its nature thereafter)
  901. which was so in tune with its users that it had *pictures* of the function
  902. keys that should be pressed.
  903.  
  904. -- The tutorial for Arts & Letters 1.0, which (unlike many  tutorials in which
  905. I felt that I was in a competition with myself for "how soon can I click on
  906. all these keys?") made me feel at the end that I actually _knew_ the basics of
  907. how to use the product.
  908.  
  909. -- CA Simply Accounting had a good manual. The product stank, but the manual
  910. did a very good job of describing how the product worked.
  911.  
  912.  > I have defaulted to typing in the first person in that section of
  913.  > the online doc. Do you feel that is appropriate?
  914.  
  915. Absolutely. Some publications really avoid writing in the first person (notice
  916. that Computer Shopper always said, "We looked at the motherboard..." as if a
  917. bunch of people were peering at the thing rather than one guy tearing apart
  918. the machine in his spare room) but I find it personal. I much prefer the
  919. first-person approach (you and I) to the impersonal "The user should type..."
  920. Actually, I try hard to keep person-ness out of the discussion; I'll say,
  921. "Press the space bar" rather than "You should press the space bar" or the
  922. yucky "the user should press the space bar."
  923.  
  924. Rather than upload the file with the entire documentation, I'd pick three
  925. screen shots and upload them in a ZIP file. You should be able to pick three
  926. representative shots that show what your product can do; few people want to
  927. know *everything* ahead of time... they just want to know why they should buy
  928. it.
  929.  
  930. --Esther
  931.  
  932. --Esther
  933.  
  934. There are 3 Replies.
  935.  
  936.  
  937. #: 69407 S20/Marketing OS/2 Apps
  938.     26-Dec-95  14:19:38
  939. Sb: #69386-#Documentation quality
  940. Fm: Guy Scharf [Sysop] 76702,557
  941. To: Esther Schindler [EXEC] 72241,1417 (X)
  942.  
  943. Esther,
  944.  
  945. Speaking entirely as a user, I have a pet peeve about printing user manuals.
  946. First, I don't like to do it.  A manual printed on 8.5x11 paper looseleaf is
  947. more unwieldy than a perfect-bound, smaller-sized manual.
  948.  
  949. But, more importantly, I have generally not be able to get the manuals to
  950. print double sided, which uses 2x as much paper as it needs to.  I *do* have a
  951. duplex printer, and one of my purposes is to save paper.  Yes, I suppose if I
  952. knew PostScript I might be able to figure out how to edit it to use the duplex
  953. feature, but that really shouldn't be required of the user.
  954.  
  955. As a user, I want the manual both in printed form *and* online!  And I want
  956. both of them to be complete.  Online is very useful for reference material and
  957. looking things up while I am working on the computer; printed is essential for
  958. study and for learning a product.  All of the vendors I have seen who have
  959. opted for electronic manuals only seem to speak to the needs of the
  960. established customer and are raising the barrier for the new customer by
  961. making their product more difficult to use than it need be.
  962.  
  963. Case in point: Quicken for Windows Deluxe version.  The diskette version has
  964. printed manuals.  The CD-ROM version has more information on the CD-ROM but
  965. lacks printed manuals.  I want the additional features, and I also want the
  966. printed manuals.  The fact that I can't get both in one box has delayed my
  967. purchase by months, and may delay it indefinitely as I decide the previous
  968. version continues to meet my needs well.
  969.  
  970. Guy
  971.  
  972.  
  973. There is 1 Reply.
  974.  
  975.  
  976. #: 69437 S20/Marketing OS/2 Apps
  977.     26-Dec-95  19:40:22
  978. Sb: #69407-Documentation quality
  979. Fm: Esther Schindler [EXEC] 72241,1417
  980. To: Guy Scharf [Sysop] 76702,557 (X)
  981.  
  982. <<Esther nods enthusiastically, in agreement>>
  983.  
  984.  
  985. #: 69426 S20/Marketing OS/2 Apps
  986.     26-Dec-95  17:40:10
  987. Sb: #69344-#Documentation quality
  988. Fm: Felix Cruz 72274,3102
  989. To: Esther Schindler [EXEC] 72241,1417 (X)
  990.  
  991. Esther,
  992.  
  993. Your points about documentation are noted.
  994.  
  995. I usually load a program and then try to use it without reading the docs
  996. (don't most end users do this? ;-) )
  997.  
  998. I agree the supporting manual should be clearly written, with a "how-to"
  999. section, supporting screen shots, as well as an introduction into the
  1000. product's capabilities. We plan to revise the product manuals as each goes
  1001. through its product cycles to orient them from the perspective of a casual,
  1002. unsophisticated user.
  1003.  
  1004. Although most people won't read them, a product's manual *does* add value to
  1005. the product, so we will continue to include them.
  1006.  
  1007.  
  1008.  
  1009.  
  1010. Felix Cruz
  1011.  SofTouch Systems, Inc
  1012.  
  1013.  
  1014. There are 2 Replies.
  1015.  
  1016.  
  1017. #: 69443 S20/Marketing OS/2 Apps
  1018.     26-Dec-95  22:49:45
  1019. Sb: #69426-#Documentation quality
  1020. Fm: Esther Schindler [EXEC] 72241,1417
  1021. To: Felix Cruz 72274,3102 (X)
  1022.  
  1023. Early adopters like us pride ourselves on the fact that we've never read the
  1024. manual. Ordinary users *do* read them... and are usually confused.
  1025.  
  1026. Apropos of this whole discussion, my next door neighbor (the one who bought a
  1027. home computer a year ago "so I could start to do some writing") called me
  1028. yesterday afternoon to ask me to help her install Myst. The short version of
  1029. the problem was that she didn't know how to tell windows "E:\setup.exe" --
  1030. because the manual said X:SETUP.EXE, and she sure didn't have an X drive. It
  1031. did say to substitute the CD ROM driver letter for X, but she didn't know the
  1032. CD ROM drive even *had* a drive letter, or what one was.
  1033.  
  1034. I talk to these people because they keep me honest. I'll rent Michelle to you,
  1035. anytime you need the same experience. <grin> (She's nice, she's pretty, she's
  1036. divorced... she has 4 kids...)
  1037.  
  1038. --Esther
  1039.  
  1040. There is 1 Reply.
  1041.  
  1042.  
  1043. #: 69451 S20/Marketing OS/2 Apps
  1044.     27-Dec-95  00:11:50
  1045. Sb: #69443-Documentation quality
  1046. Fm: Felix Cruz 72274,3102
  1047. To: Esther Schindler [EXEC] 72241,1417
  1048.  
  1049. Esther,
  1050.  
  1051. "Ordinary users *do* read them... and are usually confused."
  1052.  
  1053. Agreed. That is why the road to "perfect" documentation is always under
  1054. construction. <s>
  1055.  
  1056. BTW - We intend to approach the whole useability issue from a different
  1057. standpoint for some upcoming product upgrades by complementing the product
  1058. manual with another technique to see if this improves the customer's
  1059. experience with our products.
  1060.  
  1061.  
  1062. Felix Cruz
  1063.  SofTouch Systems, Inc
  1064.  
  1065.  
  1066. #: 69478 S20/Marketing OS/2 Apps
  1067.     27-Dec-95  12:31:51
  1068. Sb: #69451-#Documentation quality
  1069. Fm: Jim Beyer- Asst DIABETES 73060,1544
  1070. To: Felix Cruz 72274,3102 (X)
  1071.  
  1072. I am a big booster of technical writers.  I have gone so far as to make one a
  1073. partner in my current venture.  I am a developer, I know about designing
  1074. software and creating it.  I am not a technical writer, so I want on on staff.
  1075.  
  1076. Back to lurker mode.
  1077.  
  1078. FWIW
  1079. JimB     [Asst DIABETES]
  1080.  
  1081. There is 1 Reply.
  1082.  
  1083.  
  1084. #: 69511 S20/Marketing OS/2 Apps
  1085.     27-Dec-95  21:40:19
  1086. Sb: #69478-Documentation quality
  1087. Fm: Felix Cruz 72274,3102
  1088. To: Jim Beyer- Asst DIABETES 73060,1544
  1089.  
  1090. Jim,
  1091.  
  1092. > I am a big booster of technical writers. <
  1093.  
  1094. Agreed. Now, where was this discussion going? <g>
  1095.  
  1096.  
  1097. Felix Cruz
  1098.  SofTouch Systems, Inc
  1099.  
  1100.  
  1101. #: 69443 S20/Marketing OS/2 Apps
  1102.     26-Dec-95  22:49:45
  1103. Sb: #69426-#Documentation quality
  1104. Fm: Esther Schindler [EXEC] 72241,1417
  1105. To: Felix Cruz 72274,3102 (X)
  1106.  
  1107. Early adopters like us pride ourselves on the fact that we've never read the
  1108. manual. Ordinary users *do* read them... and are usually confused.
  1109.  
  1110. Apropos of this whole discussion, my next door neighbor (the one who bought a
  1111. home computer a year ago "so I could start to do some writing") called me
  1112. yesterday afternoon to ask me to help her install Myst. The short version of
  1113. the problem was that she didn't know how to tell windows "E:\setup.exe" --
  1114. because the manual said X:SETUP.EXE, and she sure didn't have an X drive. It
  1115. did say to substitute the CD ROM driver letter for X, but she didn't know the
  1116. CD ROM drive even *had* a drive letter, or what one was.
  1117.  
  1118. I talk to these people because they keep me honest. I'll rent Michelle to you,
  1119. anytime you need the same experience. <grin> (She's nice, she's pretty, she's
  1120. divorced... she has 4 kids...)
  1121.  
  1122. --Esther
  1123.  
  1124. There is 1 Reply.
  1125.  
  1126.  
  1127. #: 69487 S20/Marketing OS/2 Apps
  1128.     27-Dec-95  14:34:20
  1129. Sb: #69443-#Documentation quality
  1130. Fm: Jon Duringer[IdeaFa 71732,3361
  1131. To: Esther Schindler [EXEC] 72241,1417 (X)
  1132.  
  1133. >> Ordinary users *do* read them...
  1134.  
  1135. OS/2 and SOM allow us to create products that are radically simpler than
  1136. conventional software products.  It will take us several years to even grok
  1137. how simple desktop objects can be.  When we finally do, I think that the idea
  1138. of writing a manual will come to seem as silly as writing a manual on how to
  1139. use a pad of paper would be.
  1140.  
  1141. There are 2 Replies.
  1142.  
  1143.  
  1144. #: 69499 S20/Marketing OS/2 Apps
  1145.     27-Dec-95  18:58:48
  1146. Sb: #69487-#Documentation quality
  1147. Fm: Samuel G. Little 70544,10
  1148. To: Jon Duringer[IdeaFa 71732,3361 (X)
  1149.  
  1150.  > When we finally do, I think that the idea of writing a manual will
  1151.  > come to seem as silly as writing a manual on how to use a pad of
  1152.  > paper would be.
  1153.  
  1154. I doubt this will ever occur, Jon.
  1155.  
  1156. <Deconstructionalist hat on>
  1157.  
  1158. No matter what, one is constricted by language, and communication through
  1159. language or symbol is always faulty. The only way to overcome it is to attempt
  1160. to be as specific as possible, often taking multiple approaches. Most good
  1161. dictionaries provide two or three similar definitions for a word for just such
  1162. a reason.
  1163.  
  1164. Take almost any action name used by two or three different programs, and I'll
  1165. bet none of them do quite the same thing. Same word, different language. These
  1166. differences will always exist (though they may be reduced) and will have to be
  1167. explained.
  1168.  
  1169. <deconstructionalist hat off>
  1170.  
  1171.   --Sam. (Warped & using GCP 2.22)
  1172.     sam_little@iacnet.com
  1173.  
  1174.  
  1175. There is 1 Reply.
  1176.  
  1177.  
  1178. #: 69501 S20/Marketing OS/2 Apps
  1179.     27-Dec-95  19:27:46
  1180. Sb: #69499-Documentation quality
  1181. Fm: Jon Duringer[IdeaFa 71732,3361
  1182. To: Samuel G. Little 70544,10
  1183.  
  1184. >> I doubt this will ever occur, Jon.
  1185.  
  1186. Let me put my thought this way.  Suppose documenting software products became
  1187. absolutely illegal and impossible.  Would the software industry disappear?
  1188. No, we'd just be forced to fully exploit SOM and OS/2 to create simple,
  1189. visually intuitive objects which corresponded closely to physical objects that
  1190. everyone is familiar with.  The objects would need to be safe, intriguing, and
  1191. indestructable, kind of like the objects that we give to 2 year old toddlers.
  1192. The objects would have to do interesting things when manipulated in simple,
  1193. general ways.  The software industry wouldn't disappear, but it -would- be
  1194. radically transformed.
  1195.  
  1196. Samuel, this is where we need to go to eliminate Moore's Chasm.  With OS/2, we
  1197. -can- do this.  Let's set our sights on it, and spend the next 10 years
  1198. getting there.
  1199.  
  1200. In the short term, we do need to write better documentation.  In the longer
  1201. term, we need to start thinking about eliminating the need for documentation
  1202. altogther, to make our products like crayons, pads of paper, and staplers.
  1203.  
  1204.  
  1205. #: 69539 S20/Marketing OS/2 Apps
  1206.     28-Dec-95  00:56:17
  1207. Sb: #69501-#Documentation quality
  1208. Fm: Samuel G. Little 70544,10
  1209. To: Jon Duringer[IdeaFa 71732,3361 (X)
  1210.  
  1211.  > Suppose documenting software products became absolutely illegal
  1212.  > and impossible.  Would the software industry disappear? No, we'd
  1213.  > just be forced to fully exploit SOM and OS/2 to create simple,
  1214.  > visually intuitive objects which corresponded closely to physical
  1215.  > objects that everyone is familiar with.
  1216.  
  1217. As my grandmother taught blind children and my mother tutored developmentally
  1218. disabled people, this just *isn't* possible. To many people, the difference
  1219. between a dining room chair and a recliner are merely cosmetic. To others who
  1220. are only familiar with one, the other is incomprehensible.
  1221.  
  1222. Any visual (or audial) object is a symbol. IMO, any programmer who relies on
  1223. the intuition of his customer is going to be disappointed with the outcome.
  1224. The only way it could work is if every customer had the same experiential and
  1225. symbolic background ... or if the objects were not designed to do any work (as
  1226. in the objects one gives 2-year-olds).
  1227.  
  1228.   --Sam. (Warped & using GCP 2.22)
  1229.     sam_little@iacnet.com
  1230.  
  1231.  
  1232. There is 1 Reply.
  1233.  
  1234.  
  1235. #: 69563 S20/Marketing OS/2 Apps
  1236.     28-Dec-95  09:49:50
  1237. Sb: #69539-#Documentation quality
  1238. Fm: Jon Duringer[IdeaFa 71732,3361
  1239. To: Samuel G. Little 70544,10 (X)
  1240.  
  1241. >>To others who are only familiar with one, the other is incomprehensible.
  1242.  
  1243. What if the recliner detected the presence of a blind person, invited her to
  1244. sit down, and then slowly extended itself, whispering, "This is what I do... I
  1245. am a recliner... Doesn't that feel good..."  Perhaps sentience is the key.
  1246.  
  1247.  
  1248. >> if the objects were not designed to do any work (as in the objects one
  1249. gives 2-year-olds).
  1250.  
  1251. Perhaps what I'm suggesting isn't possible.  I certainly haven't created an
  1252. object of the class that we're discussing.  But I think that I'm going to try
  1253. to whip up some examples, just to explore what really can be done.
  1254.  
  1255. There is 1 Reply.
  1256.  
  1257.  
  1258. #: 69601 S20/Marketing OS/2 Apps
  1259.     28-Dec-95  19:01:44
  1260. Sb: #69563-#Documentation quality
  1261. Fm: Samuel G. Little 70544,10
  1262. To: Jon Duringer[IdeaFa 71732,3361 (X)
  1263.  
  1264.  > Perhaps what I'm suggesting isn't possible.
  1265.  
  1266. Any and every interface is exclusionary to some subset of potential user
  1267. population. I suppose such exclusions can be minimized given a large number of
  1268. interface parts and the ability of each object to tell that interface part
  1269. what it is, so that it doesn't matter whether the interface is graphic, text
  1270. or audial (in any language), or direct-to-brain interface!
  1271.  
  1272. I don't see this coming anytime in the near future, though....
  1273.  
  1274.   --Sam. (Warped & using GCP 2.22)
  1275.     sam_little@iacnet.com
  1276.  
  1277.  
  1278. There is 1 Reply.
  1279.  
  1280.  
  1281. #: 69608 S20/Marketing OS/2 Apps
  1282.     28-Dec-95  19:34:03
  1283. Sb: #69601-Documentation quality
  1284. Fm: Jon Duringer[IdeaFa 71732,3361
  1285. To: Samuel G. Little 70544,10
  1286.  
  1287. >> I don't see this coming anytime in the near future, though....
  1288.  
  1289. I know what you mean.  We have to focus on making sure there's food on the
  1290. table.  Still, the tools are at hand, and it wouldn't hurt to get started....
  1291.  
  1292.  
  1293. #: 69487 S20/Marketing OS/2 Apps
  1294.     27-Dec-95  14:34:20
  1295. Sb: #69443-#Documentation quality
  1296. Fm: Jon Duringer[IdeaFa 71732,3361
  1297. To: Esther Schindler [EXEC] 72241,1417 (X)
  1298.  
  1299. >> Ordinary users *do* read them...
  1300.  
  1301. OS/2 and SOM allow us to create products that are radically simpler than
  1302. conventional software products.  It will take us several years to even grok
  1303. how simple desktop objects can be.  When we finally do, I think that the idea
  1304. of writing a manual will come to seem as silly as writing a manual on how to
  1305. use a pad of paper would be.
  1306.  
  1307. There are 2 Replies.
  1308.  
  1309.  
  1310. #: 69510 S20/Marketing OS/2 Apps
  1311.     27-Dec-95  20:29:27
  1312. Sb: #69487-#Documentation quality
  1313. Fm: Esther Schindler [EXEC] 72241,1417
  1314. To: Jon Duringer[IdeaFa 71732,3361 (X)
  1315.  
  1316. Yeah, right.
  1317.  
  1318. When that day happens, let's talk about it.
  1319.  
  1320. In the meantime, I don't feel any danger that my skills as technical writer
  1321. will become irrelevant.
  1322.  
  1323. --Esther
  1324.  
  1325. There is 1 Reply.
  1326.  
  1327.  
  1328. #: 69529 S20/Marketing OS/2 Apps
  1329.     27-Dec-95  23:52:36
  1330. Sb: #69510-Documentation quality
  1331. Fm: Jon Duringer[IdeaFa 71732,3361
  1332. To: Esther Schindler [EXEC] 72241,1417
  1333.  
  1334. >> Yeah, right. When that day happens, let's talk about it.
  1335.  
  1336. Just you wait, Ms. Esther Schindler.  I'll show youuuu...... <s>
  1337.  
  1338. (It might take me a few years, but I have a feeling that you've just lit a
  1339. fire in my heart that isn't going to go out.)
  1340.  
  1341.  
  1342. #: 69344 S20/Marketing OS/2 Apps
  1343.     25-Dec-95  13:48:33
  1344. Sb: #Documentation quality
  1345. Fm: Esther Schindler [EXEC] 72241,1417
  1346. To: Herbert Ice 72370,2501 (X)
  1347.  
  1348.      <<< Start new thread from # 69335-Pound Pound Pound in S20 >>>
  1349.  
  1350.  > How importent is printed documentation to the customer?
  1351.  >
  1352.  >  Expansion:
  1353.  >
  1354.  >  I see it as being quite importent, but not for sure that for
  1355.  > certain customers, it would not be better to have the
  1356.  > documentation incorporated into the diskettes in 2 or 3 formats
  1357.  > (Ascii, Describe, AmiPro) such that they could print documentation
  1358.  > themselves at thier leisure. Really thinking about oversees
  1359.  > customers where the difference in poundage can be substantial in
  1360.  > the cost of shipping the product. Also along the lines of course,
  1361.  > that this could reduce the price, percentage wise quite a bit.
  1362.  
  1363. Online documentation works very well for some kinds of products. I think it's
  1364. entirely appropriate when the nature of the product requires that there be a
  1365. LOT of information to wade through, and no matter how good the indexing is,
  1366. it'll never be perfect. I love having the IBM Red Books in one fat CD ROM, for
  1367. instance, because when I want to look up information about CONFIG.SYS and REXX
  1368. I don't want to have to wonder where I'm most likely to find it. Compiler
  1369. documentation is another good example of where online documentation is
  1370. valuable.
  1371.  
  1372. That isn't so for most general applications, though, and it's CERTAINLY not
  1373. true of the mainstream market. Don't underestimate the value of reading the
  1374. manual into the john. Don't discount the value of screen shots and pictures
  1375. and lots of handholding.
  1376.  
  1377. I can tell you that the documentation quality for most OS/2 software stinks.
  1378. There are some notable exceptions, but they are few and far between. (And in
  1379. the good cases you *do* know who you are because I've told you so explicitly.)
  1380. Too many OS/2 ISVs have the same person write the program that wrote the
  1381. documentation, and that's a *terrible* thing to do; even if the programmer is
  1382. a good writer (which he usually isn't) he knows too much about the product and
  1383. writes with those assumptions. The reader does *not* have the same assumptions
  1384. or knowledge and is often lost.
  1385.  
  1386. As an example, I'll pick on one ISV (who knows what I think of the current
  1387. documentation because we've talked about it): Colorworks. If you already know
  1388. how to use Colorworks, or if you've seen Joel demo it, the documentation makes
  1389. perfect sense. However, if you have never used an image editing program before
  1390. (much less one that changes the paradigms), the documentation is worthless.
  1391. There's no "here's the basics" chapter, there's no tutorial. There's no video
  1392. showing how to use it. When documentation is done correctly it can save the
  1393. company gobs of money, because it's clear enough that the user learns how to
  1394. use the program and doesn't call for tech support.
  1395.  
  1396. Look carefully at the documentation produced by the top-selling applications
  1397. in your product area. What assumptions do they make about the user's
  1398. knowledge? What tone do they write with? (Most OS/2 product manuals are dry
  1399. and lifeless; good documentation is bright and cheery and friendly, like a
  1400. good cookbook.) How often do they show the screen? I've seen entirely too many
  1401. OS/2 product manuals that completely lacked a screen shot; there's no excuse
  1402. for that. (And there's even fewer screen shots in online documentation.)
  1403.  
  1404. *Never* let the person who wrote the program write the documentation. And no,
  1405. that doesn't mean "convince my wife to write it" either; your spouse has been
  1406. too close to the project too. Get a real technical writer and don't blanch
  1407. when you hear their rates.
  1408.  
  1409. Yes, in some cases having online documentation is the right way to go. But
  1410. I've seen that used entirely too often as an excuse for doing a poor job at
  1411. writing a manual.
  1412.  
  1413. --Esther
  1414.  
  1415. There are 2 Replies.
  1416.  
  1417.  
  1418. #: 69519 S20/Marketing OS/2 Apps
  1419.     27-Dec-95  22:02:49
  1420. Sb: #69344-Documentation quality
  1421. Fm: Shmuel Metz (Atid/2) 71054,3066
  1422. To: Esther Schindler [EXEC] 72241,1417 (X)
  1423.  
  1424. >> Get a real technical writer and don't blanch when you hear their rates. <<
  1425.  
  1426. But review everything that he does to ensure technical accuracy; I've seen too
  1427. many cases where the manual reads like a racy novel, but it doesn't match the
  1428. product. Plan on putting in a lot of your own time on top of what you pay the
  1429. tech writer.
  1430.  
  1431.  
  1432. Shmuel (Seymour J.) Metz, SysProg & JOAT, Atid/2, Team OS/2, Team PL/I
  1433.  
  1434.  
  1435. #: 69357 S20/Marketing OS/2 Apps
  1436.     25-Dec-95  23:28:29
  1437. Sb: #69344-Documentation quality
  1438. Fm: Herbert Ice 72370,2501
  1439. To: Esther Schindler [EXEC] 72241,1417
  1440.  
  1441. Esther,
  1442.  
  1443.  Let me say first off, that I do believe in documentation, having waded
  1444. through IBM 370, 4341, 390 PoPs I know good doc when I see it<g>, of course
  1445. that does not mean that I can write it(unforunatly).
  1446.  
  1447.  Personally I would not consider a software product unless it had both online,
  1448. and hardcopy doc, as I do believe in the power of the john<g>. Most of my
  1449. question really centers around, "does the documentation have to arrive in a
  1450. hardcopy with the package, or can it arrive in a fashion that the consumer can
  1451. print it out as they see fit?
  1452.  
  1453.  Actually I think the documentation stinks for most products, whether OS/2 or
  1454. not. I will have to defend IBM documentation (mainframe), in that the PoPs I
  1455. always found to be very good, although I would imagine that came from years of
  1456. experience. I also think that the documentation that comes with Rexx for the
  1457. VM enviroment is the best I have ever seen, in that it proceeds in 3 phases,
  1458. where you go through the users manual 3 different times, building upon what
  1459. was done the prior pass for that particular chapter. This does not restrict
  1460. you from reading cover to cover, but following the manual helps unfold Rexx
  1461. like peeling an onion. Or if you will the way most of us learn, I think.
  1462.  
  1463.  Unfortunatly, our product does not have this capability ( in some areas it
  1464. does) of progressive learning, one must comprehend it all, or nothing.
  1465. Fortunatly this is limited to the IDE, SCSI, and PCI sections. For those
  1466. sections I do not want to just retype the relevant tech. spec. (besides
  1467. copyright problems). This is an area that I have wrestled with quite a bit. I
  1468. seam to be able to explain to customers over the phone what certain portions
  1469. of the SCSI spec mean to them, and thier business, so I have defaulted to
  1470. typing in the first person in that section of the online doc. Do you feel that
  1471. is appropriate?
  1472.  
  1473.  I would agree that the person writing the code is too close to the product,
  1474. to write decent documentation, alas in my case this will have to be done for
  1475. the first go around. Then pass the doc through a technical writer ( I know a
  1476. fine tech writer back in VA) for the second pass. As in my experience, I can
  1477. get the technical parts down, but the tech writer, raises questions that I
  1478. would never think of.
  1479.  
  1480.  When you refer to "here's the basics", the first question I have coming back
  1481. to you is, "How basic is basic?". Let's take the area of hard drive
  1482. performance (in certain area's I am about to give up on basics, such as the
  1483. Process Information), does one have to start at the "This is a track, This is
  1484. a head, they comprise a cylynder ..." level. Or is this more a question of the
  1485. target audience?
  1486.  
  1487.  As to screen shots, when I upload the IWSS.INF book here to Compuserve, every
  1488. screen that the product produces is included, this has had the effect of
  1489. adding hundreds of megabytes to the size of the INF, hence there will be two,
  1490. one with, and one without, such that folks can download the little one, and
  1491. get a flavor of what the product does at little cost, if there is further
  1492. interest, they can then download the monster. I see this as helping in a
  1493. couple of ways.
  1494.  
  1495.  1. informed purchase by the consumer. Such that I am attempting to alleviate
  1496. posts on the online services of "I didn't know that this product acted in this
  1497. ridiculous fashion".
  1498.  
  1499.  2. informed purchase by the customer. If they see the ENTIRE product prior to
  1500. purchase, I hope they will know whether it fits thier needs or not. This
  1501. should reduce thier expense and mine.
  1502.  
  1503.  So my thesis is, show the online information to any and all that desire to
  1504. see the product. Talk about what it does, and DOES NOT do, and proceed from
  1505. that point.
  1506.  
  1507.  My greatest fear at this point is that the product is too technical, only
  1508. time will tell.
  1509.  
  1510.  
  1511.  Jay Ice
  1512.  Iceware Inc.
  1513.  
  1514.  
  1515. #: 69520 S20/Marketing OS/2 Apps
  1516.     27-Dec-95  22:02:57
  1517. Sb: #69357-Documentation quality
  1518. Fm: Shmuel Metz (Atid/2) 71054,3066
  1519. To: Herbert Ice 72370,2501
  1520.  
  1521. IMHO, if you've taken the trouble to put together a manual for printing, you
  1522. should offer it preprinted and prebound, at a price commensurate with
  1523. production costs. This will save paper for the customer who doesn't have
  1524. duplex printers, and will save time.
  1525.  
  1526. I see softcopy as being of value in two situations.
  1527.  
  1528. If the softcopy is organized for a hypertext viewer like IPF, than it can
  1529. provide functionality that is unavailable in hardcopy. In particular, you
  1530. should have accessible help data for all of your error messages.
  1531.  
  1532. If the product is likely to be extensively tailored by the customer, than
  1533. revisable hardcopy allows the customer to tailor the documentation to suit his
  1534. installation.
  1535.  
  1536.  
  1537. Shmuel (Seymour J.) Metz, SysProg & JOAT, Atid/2, Team OS/2, Team PL/I
  1538.  
  1539.  
  1540. #: 69631 S20/Marketing OS/2 Apps
  1541.     28-Dec-95  23:54:50
  1542. Sb: #69520-Documentation quality
  1543. Fm: Herbert Ice 72370,2501
  1544. To: Shmuel Metz (Atid/2) 71054,3066
  1545.  
  1546. Shmuel,
  1547.  
  1548.  There will most definitly be a manual, there was never any doubt of that. I
  1549. was thinking of the spiral (plastic coated) bound manual. The purpose of a
  1550. softcopy version of the doc was to reduce the street price of the product. I
  1551. was not attempting to exclude the hardcopy, only to have a product that met
  1552. both sets of consumers needs. I have been told that the European market is
  1553. fairly sensitive to the shipping costs. Add in some VAT tax, etc. I also am
  1554. aware of this from personal experience of selling into Europe.
  1555.  
  1556.  
  1557.  Jay Ice
  1558.  Iceware Inc.
  1559.  
  1560. #: 69357 S20/Marketing OS/2 Apps
  1561.     25-Dec-95  23:28:29
  1562. Sb: #69344-Documentation quality
  1563. Fm: Herbert Ice 72370,2501
  1564. To: Esther Schindler [EXEC] 72241,1417
  1565.  
  1566. Esther,
  1567.  
  1568.  Let me say first off, that I do believe in documentation, having waded
  1569. through IBM 370, 4341, 390 PoPs I know good doc when I see it<g>, of course
  1570. that does not mean that I can write it(unforunatly).
  1571.  
  1572.  Personally I would not consider a software product unless it had both online,
  1573. and hardcopy doc, as I do believe in the power of the john<g>. Most of my
  1574. question really centers around, "does the documentation have to arrive in a
  1575. hardcopy with the package, or can it arrive in a fashion that the consumer can
  1576. print it out as they see fit?
  1577.  
  1578.  Actually I think the documentation stinks for most products, whether OS/2 or
  1579. not. I will have to defend IBM documentation (mainframe), in that the PoPs I
  1580. always found to be very good, although I would imagine that came from years of
  1581. experience. I also think that the documentation that comes with Rexx for the
  1582. VM enviroment is the best I have ever seen, in that it proceeds in 3 phases,
  1583. where you go through the users manual 3 different times, building upon what
  1584. was done the prior pass for that particular chapter. This does not restrict
  1585. you from reading cover to cover, but following the manual helps unfold Rexx
  1586. like peeling an onion. Or if you will the way most of us learn, I think.
  1587.  
  1588.  Unfortunatly, our product does not have this capability ( in some areas it
  1589. does) of progressive learning, one must comprehend it all, or nothing.
  1590. Fortunatly this is limited to the IDE, SCSI, and PCI sections. For those
  1591. sections I do not want to just retype the relevant tech. spec. (besides
  1592. copyright problems). This is an area that I have wrestled with quite a bit. I
  1593. seam to be able to explain to customers over the phone what certain portions
  1594. of the SCSI spec mean to them, and thier business, so I have defaulted to
  1595. typing in the first person in that section of the online doc. Do you feel that
  1596. is appropriate?
  1597.  
  1598.  I would agree that the person writing the code is too close to the product,
  1599. to write decent documentation, alas in my case this will have to be done for
  1600. the first go around. Then pass the doc through a technical writer ( I know a
  1601. fine tech writer back in VA) for the second pass. As in my experience, I can
  1602. get the technical parts down, but the tech writer, raises questions that I
  1603. would never think of.
  1604.  
  1605.  When you refer to "here's the basics", the first question I have coming back
  1606. to you is, "How basic is basic?". Let's take the area of hard drive
  1607. performance (in certain area's I am about to give up on basics, such as the
  1608. Process Information), does one have to start at the "This is a track, This is
  1609. a head, they comprise a cylynder ..." level. Or is this more a question of the
  1610. target audience?
  1611.  
  1612.  As to screen shots, when I upload the IWSS.INF book here to Compuserve, every
  1613. screen that the product produces is included, this has had the effect of
  1614. adding hundreds of megabytes to the size of the INF, hence there will be two,
  1615. one with, and one without, such that folks can download the little one, and
  1616. get a flavor of what the product does at little cost, if there is further
  1617. interest, they can then download the monster. I see this as helping in a
  1618. couple of ways.
  1619.  
  1620.  1. informed purchase by the consumer. Such that I am attempting to alleviate
  1621. posts on the online services of "I didn't know that this product acted in this
  1622. ridiculous fashion".
  1623.  
  1624.  2. informed purchase by the customer. If they see the ENTIRE product prior to
  1625. purchase, I hope they will know whether it fits thier needs or not. This
  1626. should reduce thier expense and mine.
  1627.  
  1628.  So my thesis is, show the online information to any and all that desire to
  1629. see the product. Talk about what it does, and DOES NOT do, and proceed from
  1630. that point.
  1631.  
  1632.  My greatest fear at this point is that the product is too technical, only
  1633. time will tell.
  1634.  
  1635.  
  1636.  Jay Ice
  1637.  Iceware Inc.
  1638.  
  1639.  
  1640. #: 69582 S20/Marketing OS/2 Apps
  1641.     28-Dec-95  14:00:19
  1642. Sb: #69357-#Documentation quality
  1643. Fm: Steve Pitts 100331,1134
  1644. To: Herbert Ice 72370,2501 (X)
  1645.  
  1646. Herbert,
  1647.  
  1648. > does the documentation have to arrive in a hardcopy with the package, or can
  1649. it arrive in a fashion that the consumer can print it out as they see fit? <
  1650.  
  1651. If you are going to have docs that are designed to be read away from the
  1652. machine (and there are products which require little more than installation
  1653. instructions in a printed form, although they are few and far between. Whether
  1654. or not yours fits that category only you can tell) then they need to be
  1655. provided in a suitable hardcopy format (ie. sturdy, long lasting and able to
  1656. lay flat on a desk without having the rock of Gibraltar perched on top of them
  1657. to hold them open <g>). Providing a file that can be printed may be fine for
  1658. evaluation copies of SW but once I've paid for it I expect better.
  1659.  
  1660. The online documentation should take advantage of the product being used to
  1661. display it (ie. IPF in OS/2 terms) and not simply be a machine readable copy
  1662. of the printed version.
  1663.  
  1664. > I will have to defend IBM documentation (mainframe), in that the PoPs I
  1665. always found to be very good <
  1666.  
  1667. But only once you know what you are doing :)
  1668.  
  1669. > I also think that the documentation that comes with Rexx for the VM
  1670. enviroment is the best I have ever seen <
  1671.  
  1672. Agreed. This was the first IBM manual that I ever recommended to anyone else
  1673. as a _good_ way to learn about an IBM product
  1674.  
  1675. Cheers, Steve
  1676.  
  1677. (Using OzCIS in Hemel Hempstead, England on 28-Dec-95 at 17:43:05)
  1678.  
  1679. There is 1 Reply.
  1680.  
  1681.  
  1682. #: 69616 S20/Marketing OS/2 Apps
  1683.     28-Dec-95  21:06:55
  1684. Sb: #69582-Documentation quality
  1685. Fm: Herbert Ice 72370,2501
  1686. To: Steve Pitts 100331,1134
  1687.  
  1688. Steve,
  1689.  
  1690.  Thanks for the input, as to PoP, I don't agree that was my bible when
  1691. learning assembler.
  1692.  
  1693.  
  1694.  Jay Ice
  1695.  Iceware Inc.
  1696.  
  1697.  
  1698. #: 69676 S20/Marketing OS/2 Apps
  1699.     29-Dec-95  15:34:40
  1700. Sb: #69616-#Documentation quality
  1701. Fm: Steve Pitts 100331,1134
  1702. To: Herbert Ice 72370,2501 (X)
  1703.  
  1704. Herbert,
  1705.  
  1706. > as to PoP, I don't agree that was my bible when learning assembler. <
  1707.  
  1708. But were you sat down in front of a copy and told, here's the manual, learn
  1709. assembler?? The POP is a great reference work, and a useful adjunct to the
  1710. learning experience, but I'd hate to learn assembler with nothing else to
  1711. guide me
  1712.  
  1713. Cheers, Steve
  1714.  
  1715. (Using OzCIS in Hemel Hempstead, England on 29-Dec-95 at 20:30:05)
  1716.  
  1717. There is 1 Reply.
  1718.  
  1719.  
  1720. #: 69726 S20/Marketing OS/2 Apps
  1721.     30-Dec-95  00:55:37
  1722. Sb: #69676-Documentation quality
  1723. Fm: Herbert Ice 72370,2501
  1724. To: Steve Pitts 100331,1134 (X)
  1725.  
  1726. Steve,
  1727.  
  1728.   > But were you sat down in front of a copy and told, here's the
  1729.  > manual, learn assembler??
  1730.  
  1731.  Correct, I had progressed into writing system mods for VM by the time I took
  1732. my fist 370 assembly class.
  1733.  
  1734.  
  1735.  Jay Ice
  1736.  Iceware Inc.
  1737.  
  1738.  
  1739. #: 69407 S20/Marketing OS/2 Apps
  1740.     26-Dec-95  14:19:38
  1741. Sb: #69386-#Documentation quality
  1742. Fm: Guy Scharf [Sysop] 76702,557
  1743. To: Esther Schindler [EXEC] 72241,1417 (X)
  1744.  
  1745. Esther,
  1746.  
  1747. Speaking entirely as a user, I have a pet peeve about printing user manuals.
  1748. First, I don't like to do it.  A manual printed on 8.5x11 paper looseleaf is
  1749. more unwieldy than a perfect-bound, smaller-sized manual.
  1750.  
  1751. But, more importantly, I have generally not be able to get the manuals to
  1752. print double sided, which uses 2x as much paper as it needs to.  I *do* have a
  1753. duplex printer, and one of my purposes is to save paper.  Yes, I suppose if I
  1754. knew PostScript I might be able to figure out how to edit it to use the duplex
  1755. feature, but that really shouldn't be required of the user.
  1756.  
  1757. As a user, I want the manual both in printed form *and* online!  And I want
  1758. both of them to be complete.  Online is very useful for reference material and
  1759. looking things up while I am working on the computer; printed is essential for
  1760. study and for learning a product.  All of the vendors I have seen who have
  1761. opted for electronic manuals only seem to speak to the needs of the
  1762. established customer and are raising the barrier for the new customer by
  1763. making their product more difficult to use than it need be.
  1764.  
  1765. Case in point: Quicken for Windows Deluxe version.  The diskette version has
  1766. printed manuals.  The CD-ROM version has more information on the CD-ROM but
  1767. lacks printed manuals.  I want the additional features, and I also want the
  1768. printed manuals.  The fact that I can't get both in one box has delayed my
  1769. purchase by months, and may delay it indefinitely as I decide the previous
  1770. version continues to meet my needs well.
  1771.  
  1772. Guy
  1773.  
  1774.  
  1775. There is 1 Reply.
  1776.  
  1777.  
  1778. #: 69705 S20/Marketing OS/2 Apps
  1779.     29-Dec-95  22:28:23
  1780. Sb: #69407-#Documentation quality
  1781. Fm: Buck Bohac 70670,2352
  1782. To: Guy Scharf [Sysop] 76702,557
  1783.  
  1784. Hi Guy,
  1785.  
  1786.  > <<Esther nods enthusiastically, in agreement>>
  1787.  
  1788. <<Buck nods enthusiastically, in agreement as well.>>
  1789.  
  1790. One more thing while we're on the documentation issue.  Although screen shots
  1791. can be helpful, what really irks me is when I click on the help button in a
  1792. dialog box and I get a help screen with a picture of dialog box and some text
  1793. that says "click on the OK button to select the option, click on the CANCEL
  1794. button to go back, and click on the HELP button for help".   I want to know
  1795. what the consequences are for clicking on OK.  Why is this dialog important?
  1796. What is the definition of these terms that I don't understand?  Etc., etc.,
  1797. etc.  If you're going to go to the trouble of giving me some information, at
  1798. least give me something useful.  The worst offender is probably IBM.
  1799.  
  1800. Also, I want lots of examples, sample situations, code snippets, etc.
  1801.  
  1802. Buck
  1803.  
  1804. There is 1 Reply.
  1805.  
  1806.  
  1807. #: 69719 S20/Marketing OS/2 Apps
  1808.     29-Dec-95  23:46:23
  1809. Sb: #69705-Documentation quality
  1810. Fm: Esther Schindler [EXEC] 72241,1417
  1811. To: Buck Bohac 70670,2352
  1812.  
  1813. Yes, yes, examples! Sample situations! Pictures of the owner's dog! Humor!
  1814. <<Esther begins to drool>>
  1815.  
  1816. (Hmm. Maybe I've been working too hard. I guess it'd help if that dratted %#*@
  1817. program I'm supposed to be reviewing would actually _work_...)
  1818.  
  1819. --Esther
  1820.  
  1821.  
  1822. #: 69509 S20/Marketing OS/2 Apps
  1823.     27-Dec-95  20:29:26
  1824. Sb: #69477-Documentation quality
  1825. Fm: Esther Schindler [EXEC] 72241,1417
  1826. To: Herbert Ice 72370,2501
  1827.  
  1828. I think you're still being unclear about who will buy your product. The answer
  1829. could be as simple as, "The same people who purchase Gammatech Utilities or
  1830. Partition Magic" (in which case you find yourself with a _really_ good clue
  1831. about partnering for effective cooperative marketing), or as complex as
  1832. "Anyone who needs to manage or maintain OS/2 systems to the peak of their
  1833. performance."
  1834.  
  1835. In other words, I'm trying to get you to define, explicitly, who will USE your
  1836. program.
  1837.  
  1838. The second step is to define who will _buy_ the product which (as can be
  1839. easily demonstrated in a corporate environment) might be a very different
  1840. answer.
  1841.  
  1842. You're going to start out with power users. EVERYONE starts out with the early
  1843. adopters... or they wouldn't be called early adopters, now would they? <grin>
  1844. So design your message to appeal to them (the people who own _lots_ of
  1845. screwdrivers, not to mention a model train set, a complex kitchen gadget, and
  1846. a ham radio setup), but keep in mind that the eventual audience is much
  1847. bigger.
  1848.  
  1849. Norton Utilities' marketing really is a good model for you; originally it was
  1850. for the techies, but eventually it was marketed as the *lifesaver,* the tool
  1851. to have around if you're afraid of what could happen. I'm sure that plenty of
  1852. packages were purchased and never used, like kitchen fire extinguishers. But
  1853. notice the distinction between the early market (people who liked to muck
  1854. about with their boot records), the mainstream market (people who want the
  1855. security of a spare tire in the trunk) to the eventual use with the laggards
  1856. (subset of utilities bundled with the OS and thus invisible to the user).
  1857.  
  1858.  > to distill it down to 3 shots, somehow feels like cutting the
  1859.  > products throat
  1860.  
  1861. Jay, you _must_ find a way to do this. If for no other reason, if *you* don't
  1862. find a way to express the product's purpose in two sentences or less (and 3
  1863. screen shots or less) than other people will. A good part of what PR is really
  1864. about is defining the message you want people to get in their heads about your
  1865. company and your product. If you don't create an image, others will create it
  1866. for you... and that image might or might not be one that you'd choose.
  1867.  
  1868. Your first effort was good (though I rarely show the opening screen for
  1869. anything <grin>). Now improve it. <smile>
  1870.  
  1871. --Esther
  1872.  
  1873.  
  1874. #: 69754 S20/Marketing OS/2 Apps
  1875.     30-Dec-95  13:49:13
  1876. Sb: #69509-#Documentation quality
  1877. Fm: Charles Stirling 100010,1433
  1878. To: Esther Schindler [EXEC] 72241,1417 (X)
  1879.  
  1880. Hi,
  1881.  
  1882. I am not a developer, just a user, and had planed on just lurking here.  Must
  1883. be a busybody as well as I can't just lurk, want to see OS/2 stuff sold.
  1884.  
  1885. The comment "Anyone who needs to manage or maintain OS/2 systems to the peak
  1886. of their performance" aims the product to high and excludes to many potential
  1887. purchasers.  I think you need to aim more at where Norton Utilities'
  1888. Quarterdeck Manifest ended up aiming -- not the power user but the concerned
  1889. user with the power user included.  Instead of "... to the peak of their
  1890. performance" to "... improve performance".  This would not put the middle
  1891. ground person as they could get something out of it and descover more.
  1892.  
  1893. On documentation, it almost sounds like two manuals are needed.  The 200+ page
  1894. one that gives all the depth might be OK for me even as a zip file on disk as
  1895. the technical referance.  A printed one that gives, as Esther has pointed out,
  1896. from the very basic, including what can be done, to the general usage maybe
  1897. with side notes to the more technical manual as tips in the margin.  Yes, a
  1898. printed technical manual would be preferable, but cost comes into this also.
  1899. What does it cost for a print run of say 2000 copies, 5000 copies of 200+
  1900. pages plus the extra postage to send say to me in England.
  1901.  
  1902. Charles
  1903.  
  1904. There is 1 Reply.
  1905.  
  1906.  
  1907. #: 69769 S20/Marketing OS/2 Apps
  1908.     30-Dec-95  20:12:34
  1909. Sb: #69754-Documentation quality
  1910. Fm: Herbert Ice 72370,2501
  1911. To: Charles Stirling 100010,1433
  1912.  
  1913. Charles,
  1914.  
  1915.  PMFJI,
  1916.  
  1917.   > The comment "Anyone who needs to manage or maintain OS/2 systems
  1918.  > to the peak of their performance" aims the product to high and
  1919.  > excludes to many potential purchasers.
  1920.  
  1921.  I would agree if the product was intended try to sell thousands per day, from
  1922. day one, say like windos95<G>, seems it missed the hyped mark though<VBG>.
  1923.  
  1924.  Esther and yourself, have split the market into three sections, technical,
  1925. power/concerned, and the tail end. At this juncture, the technical market
  1926. seems the better place to me, for the following reasons,
  1927.  
  1928.  1. Customer support will be reduced, as in general when dealing with the
  1929. corporate/technical market, there is in general one point of contact (while it
  1930. may be one point per site, that still is better than thousands). While of
  1931. course everyone that purchases a given product does not call, even a small
  1932. percentage (5->10) can be very difficult to provide decent service to.
  1933.  
  1934.  2. The feedback on the technical side I feel will be of higher quality, those
  1935. things which I missed, those things I thought to be not importent but which
  1936. the customer does feel is importent. Then will come the layout of the data,
  1937. screens etc. to a lessor degree.
  1938.  
  1939.  3. When the power user begins to purchase, this group I expect will focus on
  1940. the technical side, but with a keener interest in the asthetics of the
  1941. product, which has to happen.
  1942.  
  1943.  4. In order to appeal to the mass market, in order to have the online
  1944. services have the usage of "cool"/"kewl". etc.
  1945.  
  1946.  I may have the wrong plan in my head but I see a staged rollout of the
  1947. product, much as Esther alluded too with Norton Utilities.
  1948.  
  1949.  Documentation,
  1950.  
  1951.  Splitting into two seperate documents is a fine idea, along with having a
  1952. quick reference card. Quick refs are not expensive (7 panel, heavy stock,
  1953. generally hits around a $1 a ref), and the customer bases that I have dealt
  1954. with seem to appreciate them quite a bit, consultants in particular like to
  1955. have two in the package, one for the briefcase, one for the workplace. Nor do
  1956. they add significantly to shipping wieght.
  1957.  For a decent quality paper ( 20# bond, matte finish, so that it does have
  1958. glare under flourescent light, heavy stock for front and back, and plastic
  1959. spiral bound so that it will lay flat), I have been quoted in the Reston VA.
  1960. area as high as $800 for 100 copies not to exceed 75 pages. The reason that
  1961. the quantity was so low, was due to I have no idea how well the product will
  1962. sell, and during my years in development, I have seen hundreds of thousands of
  1963. dollars in doc pitched. I also expect that there will have to be a fairly
  1964. quick update to the product after ship in order to meet certain users
  1965. expectations, and this always leads to invalidating the documentation that one
  1966. currently has.
  1967.  
  1968.  
  1969.  Jay Ice
  1970.  Iceware Inc.
  1971.  
  1972.  
  1973. #: 69443 S20/Marketing OS/2 Apps
  1974.     26-Dec-95  22:49:45
  1975. Sb: #69426-#Documentation quality
  1976. Fm: Esther Schindler [EXEC] 72241,1417
  1977. To: Felix Cruz 72274,3102 (X)
  1978.  
  1979. Early adopters like us pride ourselves on the fact that we've never read the
  1980. manual. Ordinary users *do* read them... and are usually confused.
  1981.  
  1982. Apropos of this whole discussion, my next door neighbor (the one who bought a
  1983. home computer a year ago "so I could start to do some writing") called me
  1984. yesterday afternoon to ask me to help her install Myst. The short version of
  1985. the problem was that she didn't know how to tell windows "E:\setup.exe" --
  1986. because the manual said X:SETUP.EXE, and she sure didn't have an X drive. It
  1987. did say to substitute the CD ROM driver letter for X, but she didn't know the
  1988. CD ROM drive even *had* a drive letter, or what one was.
  1989.  
  1990. I talk to these people because they keep me honest. I'll rent Michelle to you,
  1991. anytime you need the same experience. <grin> (She's nice, she's pretty, she's
  1992. divorced... she has 4 kids...)
  1993.  
  1994. --Esther
  1995.  
  1996. There is 1 Reply.
  1997.  
  1998.  
  1999. #: 69782 S20/Marketing OS/2 Apps
  2000.     30-Dec-95  21:26:16
  2001. Sb: #69443-#Documentation quality
  2002. Fm: Shmuel Metz (Atid/2) 71054,3066
  2003. To: Esther Schindler [EXEC] 72241,1417 (X)
  2004.  
  2005. >> Early adopters like us pride ourselves on the fact that we've never read
  2006. the manual. Ordinary users *do* read them... and are usually confused. <<
  2007.  
  2008. My experience is just the opposite. The ordinary users are the ones that don't
  2009. read the manuals unless they have to, and sometimes not even then.
  2010.  
  2011. Admittedly there are a lot of programmers who hate the read manuals, but the
  2012. ones that I respect are all voracious readers. Coincidence? Perhaps, but I
  2013. don't believe it.
  2014.  
  2015. Of course, sometimes you flat don't have time to read everything that you want
  2016. to (or need to), but that's a separate issue.
  2017.  
  2018.  
  2019.  
  2020. Shmuel (Seymour J.) Metz, SysProg & JOAT, Atid/2, Team OS/2, Team PL/I
  2021.  
  2022. There is 1 Reply.
  2023.  
  2024.  
  2025. #: 69784 S20/Marketing OS/2 Apps
  2026.     30-Dec-95  21:58:29
  2027. Sb: #69782-Documentation quality
  2028. Fm: Esther Schindler [EXEC] 72241,1417
  2029. To: Shmuel Metz (Atid/2) 71054,3066
  2030.  
  2031. It depends on the nature of the "ordinary" user, and the training that the
  2032. user was given.
  2033.  
  2034. Most people who want to be experts (in whatever field they choose) are
  2035. voracious readers, or at the least voracious learners. (These are generally
  2036. intersecting sets, but not always.) People do learn differently; some learn
  2037. from a book, others learn by watching someone do it, etc. The manual writer
  2038. can't change that, but at the very least she has to write the manual *as if*
  2039. someone will try to learn everything about the product from it, and *as if*
  2040. it's the primary source of knowledge.
  2041.  
  2042. I rarely classify programmers as "ordinary users." ;-)
  2043.  
  2044. --Esther
  2045.  
  2046.  
  2047. #: 69501 S20/Marketing OS/2 Apps
  2048.     27-Dec-95  19:27:46
  2049. Sb: #69499-Documentation quality
  2050. Fm: Jon Duringer[IdeaFa 71732,3361
  2051. To: Samuel G. Little 70544,10
  2052.  
  2053. >> I doubt this will ever occur, Jon.
  2054.  
  2055. Let me put my thought this way.  Suppose documenting software products became
  2056. absolutely illegal and impossible.  Would the software industry disappear?
  2057. No, we'd just be forced to fully exploit SOM and OS/2 to create simple,
  2058. visually intuitive objects which corresponded closely to physical objects that
  2059. everyone is familiar with.  The objects would need to be safe, intriguing, and
  2060. indestructable, kind of like the objects that we give to 2 year old toddlers.
  2061. The objects would have to do interesting things when manipulated in simple,
  2062. general ways.  The software industry wouldn't disappear, but it -would- be
  2063. radically transformed.
  2064.  
  2065. Samuel, this is where we need to go to eliminate Moore's Chasm.  With OS/2, we
  2066. -can- do this.  Let's set our sights on it, and spend the next 10 years
  2067. getting there.
  2068.  
  2069. In the short term, we do need to write better documentation.  In the longer
  2070. term, we need to start thinking about eliminating the need for documentation
  2071. altogther, to make our products like crayons, pads of paper, and staplers.
  2072.  
  2073.  
  2074. #: 69783 S20/Marketing OS/2 Apps
  2075.     30-Dec-95  21:26:23
  2076. Sb: #69501-Documentation quality
  2077. Fm: Shmuel Metz (Atid/2) 71054,3066
  2078. To: Jon Duringer[IdeaFa 71732,3361 (X)
  2079.  
  2080. >> The objects would need to be safe, intriguing, and indestructable, kind of
  2081. like the objects that we give to 2 year old toddlers. <<
  2082.  
  2083. I'd hate to have to repair a car or a computer using only tools suitable for a
  2084. toddler!
  2085.  
  2086.  
  2087. Shmuel (Seymour J.) Metz, SysProg & JOAT, Atid/2, Team OS/2, Team PL/I
  2088.  
  2089.