User documentation
Written or other visual
information about how an
application system works,
and how to use it.
External documentation
System documentation that
includes the outcome of
structured diagramming
techniques such as data-flow
and entity-relationship diagrams.
Internal documentation
System documentation that is part
of the program source code or is
generated at compile time.
System documentation
Detailed information about a
system’s design specifications, its
internal workings, and its
functionality.
Chapter 10 Systems Implementation and Operation 333
support. Whether a lapse in service is required or not, the installation schedule
should be announced to users well in advance to let them plan their work
schedules around outages in service and periods when their system support
might be erratic. Successful installation steps should also be announced, and
special procedures put in place so that users can easily inform you of problems
they encounter during installation periods. You should also plan for emergency
staff to be available in case of system failure so that business operations can
be recovered and made operational as quickly as possible. Another considera-
tion is the business cycle of the organization. Most organizations face heavy
workloads at particular times of the year and relatively light loads at other
times. A well-known example is the retail industry, where the busiest time of
the year is the fall, right before the year’s major gift-giving holidays. You
wouldn’t want to schedule installation of a new point-of-sale system to begin
December 1, for a department store.
Planning for installation may begin as early as the analysis of the organization
supported by the system. Some installation activities, such as buying new hard-
ware, remodeling facilities, validating data to be transferred to the new system,
and collecting new data to be loaded into the new system, must be done before
the software installation can occur. Often the project team leader is responsible
for anticipating all installation tasks and assigns responsibility for each to
different analysts.
Each installation process involves getting workers to change the way they
work. As such, installation should be looked at not as simply installing a new
computer system, but as an organizational change process. More than just a
computer system is involved—you are also changing how people do their jobs
and how the organization operates.
Documenting the System
In one sense, every information systems development project is unique and will
generate its own unique documentation. In another sense, though, system
development projects are probably more alike than they are different. Each
project shares a similar systems development life cycle, which dictates that cer-
tain activities be undertaken and that each of those activities be documented.
Specific documentation will vary depending on the life cycle you are following,
and the format and content of the documentation may be mandated by the
organization you work for. Start developing documentation elements early, as
the information needed is captured.
We can simplify the situation by dividing documentation into two basic types,
system documentation and user documentation. System documentation
records detailed information about a system’s design specifications, its internal
workings, and its functionality. System documentation can be further divided
into internal and external documentation. Internal documentation is part of
the program source code or is generated at compile time. External documen-
tation includes the outcome of all of the structured diagramming techniques
you have studied in this book, such as data-flow and entity-relationship dia-
grams. User documentation is written or other visual information about how
an application system works and how to use it. Although not part of the code
itself, external documentation can provide useful information to the primary
users of system documentation—maintenance programmers. For example,
data-flow diagrams provide a good overview of a system’s structure. In the past,
external documentation was typically discarded after implementation, primarily
because it was considered too costly to keep up to date but today’s integrated
development environment makes it possible to maintain and update external
documentation as long as desired.