home *** CD-ROM | disk | FTP | other *** search
/ Black Box 4 / BlackBox.cdr / textinfo / guide.arj / OVERVIEW.DOC < prev   
Encoding:
Text File  |  1990-05-10  |  12.1 KB  |  203 lines
  1.                         program name: ____________________        _________
  2.                         version num.: _____  date: _______        DISK ID #
  3.  
  4.          Author:  _________________________________________________________
  5.          Address: _________________________________________________________
  6.          __________________________________________________________________
  7.          Telephone number: ________________________________________________
  8.  
  9.                                    Requirements
  10.          r = minimum required   s = supported/optional    n = not supported
  11.          ******************************************************************
  12.          Computer        Memory      Monitor     Printer       Input Device
  13.          (_) Any MSDOS   (_) <=128k  (_) Any     (_) Any       (_) any kybd
  14.          (_) PC/XT only  (_) <=256k  (_) CGA     (_) Dot Mtrx. (_) 12 fkeys
  15.          (_) 286/386     (_) <=512k  (_) EGA     (_) Laser     (_) Mouse
  16.          (_) 386 only    (_) <=640k  (_) VGA     (_) Graphics  (_) Joystick
  17.          (_) Laptop      (_) EMS___  (_) Herc    (_) Color     (_) Digitiz.
  18.          (_) __________  (_) EEMS__  (_) Mono    (_) Pin Feed  (_) ________
  19.          __________________________________________________________________
  20.  
  21.          # Drives       Modem      Software       DOS         Experience
  22.          (_) 5.25"      (_)  300   (_) BASIC      (_) 2.x     (_) None
  23.          (_) 3.5" 720k  (_) 1200   (_) Windows    (_) 3.x     (_) Beginning
  24.          (_) 3.5" 1.4m  (_) 2400   (_) ________   (_) 4.x     (_) Moderate
  25.          (_) 1.2 meg    (_) 4800   (_) ________   (_) OS/2    (_) Expert
  26.          (_) Hard disk  (_) 9600   (_) ________   (_) ______  (_) _________
  27.  
  28.          Other Requirements: ______________________________________________
  29.          __________________________________________________________________
  30.          __________________________________________________________________
  31.  
  32.                                 Program Description
  33.          ******************************************************************
  34.          Purpose: _________________________________________________________
  35.          __________________________________________________________________
  36.          __________________________________________________________________
  37.          Features:_________________________________________________________
  38.          __________________________________________________________________
  39.          __________________________________________________________________
  40.          __________________________________________________________________
  41.          __________________________________________________________________
  42.          __________________________________________________________________
  43.          __________________________________________________________________
  44.          __________________________________________________________________
  45.          __________________________________________________________________
  46.          __________________________________________________________________
  47.          __________________________________________________________________
  48.          __________________________________________________________________
  49.          __________________________________________________________________
  50.          __________________________________________________________________
  51.          __________________________________________________________________
  52.          __________________________________________________________________
  53.          __________________________________________________________________
  54.          __________________________________________________________________
  55.          __________________________________________________________________
  56.          __________________________________________________________________
  57.          __________________________________________________________________
  58.          __________________________________________________________________
  59.          __________________________________________________________________
  60.            Please be concise and limit descriptions to the space above.
  61.             If certain features or documentation are available only to
  62.                   registered users, please indicate them clearly.
  63.  
  64.                              The Public (Software) Library
  65.                          P.O.Box 35705  Houston, TX 77235-5705
  66.                                      (713) 524-6394
  67.  
  68.          
  69.  
  70.                        How PSL Distills a Program Description
  71.  
  72.          The following is an example of how we have to cull a more  concise
  73.          description of a program from the documentation files. The way  we
  74.          go about it is to pull out only the information that would, in our
  75.          judgement, affect a person's decision to try the program.  Authors
  76.          frequently list minor  points about how  a program works  that are
  77.          not critical in  deciding on a program,  or they may make frequent
  78.          use of words like  "efficient, easy, powerful" that are completely
  79.          subjective. Such hype is perfectly  all right in the author's  own
  80.          documentation file, but not essential to a concise description.
  81.  
  82.          In the following example,  we first list a paragraph straight from
  83.          a typical documentation file and then follow it with our condensing
  84.          of the facts in square brackets or our comments in parentheses:
  85.  
  86.  
  87.         "This checking program has been designed to efficiently and  easily
  88.          allow anyone to keep track of one or more home or office  checking
  89.          accounts. With this program, checking information (including check
  90.          numbers, check dates, comments, amounts, balances, and descriptive
  91.          codes) can be stored on disks where it can be easily accessed  for
  92.          reference, revision or addition."
  93.  
  94.         [This ........ program ............................................
  95.          allows you to keep track of ............. home or office  checking
  96.          accounts. ........................................................
  97.          ...............(Data being stored on disk in not news)............
  98.          ..................................................................
  99.          ................................]
  100.  
  101.         "Check files may be searched to find any specific entry with any of
  102.          the above  specified fields  and files  can be  manipulated easily
  103.          through the program  with options like  merging files, backing  up
  104.          files, deleting and renaming files. The year-end processing option
  105.          will allow the  operator to create  a separate, finalized  file of
  106.          all the checking transactions for a specified period of time."
  107.  
  108.         [Check files may be searched by check number, date, comment, amount,
  109.          balances or descriptive code. ...............(Copying and renaming
  110.          files is not information critical to evaluating an accounting pro-
  111.          gram.  The problem is,  the author doesn't say what such things as
  112.          creating a "finalized file of all the checking transactions"  will
  113.          actually do for the user.) ..................................]
  114.  
  115.         "This program will allow the  operator to create his own  code file
  116.          in which  he can  store up  to 677  two letter  codes - (the first
  117.          letter being a general heading, the second, a more specific  code,
  118.          ie. OF  = Office  Furniture, OS  = Office  Supplies etc.)  and 677
  119.          accompanying twenty-five letter  definitions. These codes  will be
  120.          used in describing check categories."
  121.  
  122.         [Up to 677 user-defined account codes and descriptions are allowed.
  123.          ..................................................................
  124.          ..................................................................
  125.          ..................................................................
  126.          ..................................................................
  127.          ....................................]
  128.  
  129.         "Check files  may be  reconciled with  the operator's  monthly bank
  130.          statement through the reconciliation section of this program. Bank
  131.          charges  can  be  added  to  the  check  file  and amounts will be
  132.          verified to see if there have been any skipped or mistyped  checks
  133.          in the file or errors in the bank statement."
  134.  
  135.         [Checking account reconciliation is supported. ....................
  136.          ..................................................................
  137.          ..................................................................
  138.          ..................................................................
  139.          ............................................]
  140.  
  141.         "As a special feature, check files may be sorted according to  code
  142.          categories. Automatically,  you can  get a  listing of  all of the
  143.          entries  in  your  file,  between  any  specified  dates,   sorted
  144.          according to the two letter  check code assigned to it,  or simply
  145.          list all of the entries in one general or specific code  category.
  146.          Great for income tax purposes!"
  147.  
  148.         [You can  list checks  for any specified  period sorted  by account
  149.          code. This is useful for income tax purposes. ....................
  150.          ..................................................................
  151.          ..................................................................
  152.          ..................................................................
  153.          ..............................]
  154.  
  155.         "This program will allow the  operator many options in editing  and
  156.          manipulating check  and code  files and  it will  make bookkeeping
  157.          less time and space consuming and more accurate and efficient."
  158.  
  159.         [...........(The above should go without saying.)..................
  160.          ..................................................................
  161.          ...............................................................]
  162.  
  163.         "This checking program is designed  so that anyone can use  it, and
  164.          use  it  correctly.  By  reading  this  manual  and  following the
  165.          prompts, the operator should be able to use this checking  program
  166.          correctly."
  167.  
  168.         [............. (We would not accept a simple checkbook program into
  169.          the library if it were not "designed so that anyone can use it and
  170.          use it correctly". So this goes without saying.) .................
  171.          ..........]
  172.  
  173.  
  174.          Librarian's Summary of the Facts:
  175.  
  176.          This  program  lets  you  keep  track  of  home or office checking
  177.          accounts. Entries can be searched by check number, date,  comment,
  178.          amount, balances or descriptive code. The program allows up to 677
  179.          user-defined accounts. It aids you in reconciling your bank state-
  180.          ment. You can print out checks for any specified period sorted  by
  181.          account code. This is useful for income tax and other purposes.
  182.          ------------------------------------------------------------------
  183.  
  184.          We have had programmers ask us to do a "big writeup" of their pro-
  185.          gram rather than  "a brief mention".   As you can see above,  our
  186.          summary of the facts can be the equivalent of a much longer write-
  187.          up that has a lot of  air in it.  And the advantage of our summary
  188.          is that  people are more likely to read a  short paragraph about a
  189.          program than a page or two of b.s.
  190.  
  191.          What we DO encourage is for you to compare your program to other
  192.          programs like it (retail, as well as pd/shareware) and report the
  193.          differences. A comparative chart of features is most helpful, but
  194.          don't just put the features in the chart that make your program
  195.          look good. If it is not an honest comparison, you are only fooling
  196.          yourself. Instead, use what you have learned from studying the
  197.          other programs to make YOURS the best!
  198.  
  199.          Another useful thing to submit is camera ready copy of an attractive
  200.          screen from your program. For PsL's purposes, the copy should be no
  201.          more than 6.5" wide.
  202.          
  203.