


                               PLAN: A user guide
                               ==================

     INTRODUCTION
     ============

     PLAN is a critical path analysis  tool  for planning projects small or
     large.  In essence you tell the program:

     -  what jobs need to be done
     -  what resources (people, equipment, etc) are needed for each job
     -  how much each job will cost in materials
     -  which jobs must be completely or partially finished before another
        can begin
     -  what is the very earliest each job can start if everything were
        available

     and in return the program calculates all of the dates and gives you:

     -  a detailed day-by-day plan of all of the jobs, either as a chart
        or as a report
     -  details of how late a particular job can be left without affecting
        the overall completion date of the project
     -  details of the costs incurred each week during the project
     -  details of how many of each resource you will need each week.


     RUNNING THE PROGRAM
     ===================

     Firstly you must prepare a document in ASCII format containing details
     of the individual jobs in  your  project.   You  can  do this with any
     word-processor as long as you remember  to  save the document as ASCII
     (in PROTEXT, for example, use SAVEA instead of SAVE, in FIRSTWORD turn
     off the WORDPROCESSOR option).  The  format  of this document is given
     below.

     When you have created  the  document  describing  your project, simply
     double-click on PLAN.PRG.   It  will  ask  you  for  the  name of your
     document.  Type this  in  (eg.  a:\planning\plana)  and  press RETURN.
     Then simply follow the instructions.

     DOCUMENT FORMAT
     ===============

     In order to help you,  a  document  called  EXAMPLE is included on the
     disc.  It is probably easiest  to  copy  this  and then modify it with
     details of your project.  If you  would  rather type from scratch then
     note the following:

     1.  any line beginning with a  percentage  sign  (%)  is ignored by the
         program.  Use these lines to record informal information about your
         project.

     2.  whenever a date is needed  enter  it  normally with slashes between
         the days, months and years.  For example: 4/5/91.

     3.  if things won't  fit  onto  one  line  (this  normally happens with
         'activity' lines) then end the line with a plus (+) and continue on
         the next line.  Here is an example:

         You can write

                   activity wash walls (earliest 12/1/90) (needs 1 man)

         or

                   activity wash walls +
                       (earliest 12/1/90) +
                       (needs 1 man)

         and they both mean the same.

     4.  spaces between words don't matter  except  in  the names of things.
         Thus, for example

         dependency 100  wash walls -> paint walls

         and

         dependency        100    wash walls     ->       paint walls

         are treated exactly the same  but  don't insert more spaces between
         'wash' and 'walls' as 'wash walls' is  the  name of a job.  You can
         use this to  line  things  up  nicely  to  make  your document more
         readable.

     5.  somewhere in the document you  should  enter the following keywords
         at the beginning of a  line  with the appropriate information after
         them:

         title

         example:     title Redecorating the House

         (this, reasonably enough, is the  title  of  the  plan as it should
         appear on reports)

         planner

         example:      planner Chris Hobbs

         (the name of the person putting the plan together)

         version

         example:       version 1

         (the version of the document you  have  reached (plans have a habit
         of changing when a job is completed early  or late): 1, 2, 3 ... or
         a, b, c ... or whatever you wish)

         base

         example:        base 11/6/91

         (the basedate of the plan.   No  dates  may be entered earlier than
         this)

     6.  for each resource, which may be  a  person or a piece of equipment,
         you must enter a line beginning

         resource

         example:        resource managers

         You cannot use a resource before  you  have declared it in this way
         so it's probably  best  to  put  all  of  these  sort of statements
         somewhere near the top of the document.

     7.  for each activity you must enter a line beginning

         activity

         followed by the name  of  the  activity  and  then several optional
         fields.  Here  is  an  example  with  all  of  the  optional fields
         completed:

         activity Wash Walls (earliest 12/1/92) (duration 10,12,15) +
                             (cost 150) (needs 1 bucket) (needs 2 men)

         'Wash Walls' is the name of the job to be done.  For some reason it
         cannot  start  earlier   than   12/1/92   (perhaps   the  Christmas
         decorations must be down first), it  will probably take 12 days but
         it might be finished in 10 but  it  might take 15, it will cost 150
         pounds (for the water?), and it will need 1 bucket and two men.

         If 'earliest' is missing then the  program will schedule the job to
         start as soon as  any  earlier  jobs  (see below: dependencies) are
         complete.

         If 'duration' is missing  then  the  program  assumes  that the job
         takes no time.

         If 'cost' is missing then  the  program  assumes  that there are no
         costs other than labour costs associated with the job.

         If 'needs' is missing then  the  program  assumes that no resources
         are needed for the job.  You  can  enter  as many 'needs' against a
         job as you like.

     8.  if one job  cannot  begin  until  all  or  some  of  another job is
         finished then you should  enter  'dependency' statements.  Here's a
         couple of examples:

         dependency 100 wash walls -> paint walls
         dependency 60  paint walls -> remove floor covering

         These statements tell the program that 100% of the job 'wash walls'
         must be complete before the job 'paint walls' can begin.  Similarly
         when 60% of the  painting  is  complete  we  can start removing the
         floor covering.

     9.  if there are holidays which  will  occur during the project, during
         which you don't want the program to schedule work, then simply list
         them, one per line, with the keyword 'holiday' in front of them:

         holiday 25/12/90
         holiday 26/12/90


     10. the order in which  items  should  be  included  in the document is
         relatively free except  that  nothing  can  be  used  unless it has
         previously been declared.  As a rule of thumb, put the items in the
         following order and there will be no problem:

         title, planner, base, version
         holidays
         resources
         activities
         dependencies


     PROGRAM OPTIONS
     ===============

     When you run the programme you are offered a menu to choose from.  The
     options are as follows:

        List Activities
        ---------------

        This simply lists the activities  to  the  screen or disc file (for
        later printing or bringing into a word processor)

        List Dependencies
        -----------------

        This simply lists the dependencies to the screen or disc file.

        Calculate Schedule
        ------------------

        There are four options here:  to  calculate  the schedule using the
        minimum times  that  you  have  given  for  each  activity  (a very
        optimistic schedule), the probable times, the maximum times (a very
        pessimistic schedule) or using weighted times (the most believeable
        schedule).  Weighted times are calculated as

        (min time + 4 * prob time + max time) / 6

        which is a common scheduling trick  to  get  a realistic time for a
        job.

        Print Schedule
        --------------

        There are three ways to print the schedule: as a report, as a daily
        bar-chart or as a weekly bar-chart.  On the report the earliest and
        latest dates for the start and finish  of each job are given unless
        the job MUST start on schedule  when  no  latest date is given.  On
        the bar-charts the earliest a job  could  be done is shewn by equal
        signs (=) and any possible slip by minus signs (-).  Thus

        Wash Walls         =========

        shews a job which must be completed on the days shewn whereas

        Wash Walls         =========------------

        shews a job which  can  be  completed  early  but  could be slipped
        without affecting the overall project.

        If you print a bar-chart  then  the  program  will ask you how wide
        your page (or screen) is  as  the  report  will probably need to be
        broken into several parts to fit on  the page.  A suitable value if
        you are displaying on the screen  is  75:  don't try to use 80.  If
        you print such a  report  then  you  will  need  to  glue the parts
        together to get one long printout.

        Print Resources
        ---------------

        This gives a list of how many  of each resource will be needed each
        week.

        Print Costs
        -----------

        This gives a list of how much cost will be incurred each week.


     ERROR MESSAGES
     ==============

     There are really only two types of  the error message displayed by the
     program.  The first occurs if you  use,  for example, a resource which
     you have  not  included  in  a  'resource'  statement  earlier  in the
     document.  A common error is to declare

     resource  programmer

     to make 'programmer' a  resource  and  then,  in  the definition of an
     activity, write

     activity write code (needs 2 programmers)

     The program will, quite correctly, tell  you that 'programmers' is not
     a valid resource.  You must  either write 'resource programmers' (with
     the final 's') or '(needs 2 programmer)'.

     The second sort of error  message  arises  if  you  try to calculate a
     schedule which is impossible.  Say you  have  three  jobs, A, B and C,
     and you set up the dependencies

     dependency 100 A -> B
     dependency 100 B -> C
     dependency 100 C -> A

     This is a fairly blatant example  and  your  mistakes are likely to be
     more subtle.  This tells the program  that  B  cannot begin until A is
     complete, that C cannot begin until  B  is complete and A cannot begin
     until C is  complete.   Naturally  the  program  won't  allow this and
     displays a message asking you to correct the dependencies.


     QUESTIONS AND ANSWERS
     =====================

     Why doesn't the program use fancy GEM windows?
     ----------------------------------------------

     Because although it was developed on  the  ST  it has also been run on
     IBM PCs and micro-VAX computers  with  dumb terminals.  The program is
     written in SOZOBON C (the  best  public  domain disc in existence) and
     was easily ported to the  other  machines  which it wouldn't have been
     had it used pull-down menus, file selection boxes, etc.

     Has the program been used in earnest?
     -------------------------------------

     Yes certainly.  At  the  lab  where  I  work  we  use  ARTEMIS for our
     planning, a very sophisticated  tool.   In  order  to  rough out plans
     before digging into ARTEMIS we use PLAN.  It has been used by numerous
     engineers in addition to myself, all  of whom have requested additions
     and enhancements which I have ignored.   The  fact that the program is
     still used is a testament to its usefulness.

     PLAN doesn't allow me to specify  a  maximum number of resources.  How
     do I stop it allocating too many in a particular week?
     ------------------------------------------------------

     This  is  where  we  reach  the   borderline  between  PLAN  and  more
     sophisticated tools.  I run  the  schedule,  find  the week giving the
     problem from the resource  printout  and  then introduce an 'earliest'
     parameter to force some jobs to start later.

     How do I get a print of the reports?
     ------------------------------------

     Select FILE when offered 'FILE or  SCREEN'  and  then, when all of the
     reports have been filed, leave PLAN and  double click on each file and
     select PRINT.  This technique is  also  useful for including printouts
     from PLAN in wordprocessor documents: all reports are written to files
     in plain ASCII.
