Maintenance of Software Solutions

Documentation of Changes

What happens when a modification is made?

When modifications are made all internal and external documentation may also need to be altered.

Large projects that have multiple modifications may also require monitoring and tracking of changes which is also a facet of documentation.

Identify how modifications are tracked in

computer programs.

What happens when a modification is made?

Versioning

Modification Of Internal Documentation

All altered source code should contain the following: Who made the change? Date Changes evident.

Should employ all strategies used when documenting the solution in other stages.

Activity – Internal Documentation

A client database program has been modified to include new search and print modules. Also a sort procedure has been changed to incorporate a selection sort rather than a bubble sort.

Identify THREE areas of internal documentation that should be modified to ensure that effective maintenance can be continually implemented.

Activity – Internal Documentation

Answer

Intrinsic Naming Indentation of control structures Comments

Modification Of External Documentation

The changes in the structure of a program may also have an effect on external documentation related to the program.

Activity – External Documentation

HP has just developed a new driver for its HP890 printer. The new driver supports users to change the RGB colours used and also to print in a low usage monochrome mode.

Identify the documentation changes that should be made to ensure users are well informed and supported regarding changes.

Activity – External Documentation

Answers Changes to online help. Changes to tutorials. Changes to printer common dialog box. Changes to the print driver link on the website. Informing users of changes.

Use of CASE Tools

Maintenance is definitely a complex and time consuming process.

CASE tools are available to automate this process.

Examples – Version Control

Version control CASE tools manage multiple versions of software components or modules.

Records of previous versions are kept and maintained.

Major changes create a version to change from 2.5 to 3.0.

Minor version changes will result in a cahnge from 4.1 to 4.2.

Activity

Create a timeline of the various major versions of Microsoft Windows.

Answers

Windows 1.0, 2.0, 3.0, 3.1 Windows 95 Windows NT 4.0 Windows 98 Windows 2000 Windows ME Windows XP Windows Longhorn

Activity

The developer of a program called OOTher uses a CASE tool to assist in documenting the versioning notes and help users understand modifications.

Modifications

Version 1.01 Bug corrections to eliminate 2/0 error.

Activity

Version 1.02 Changes to save dialog box colours.

Version 1.11 Changes to menus in GUI.

Version 2.01 Changes to print module to allow a new driver.

Activity

Answer the following:

1. Identify what type of change would have occurred between 1.11 and 2.01.

2. Draw a hierarchy chart to show the different versions.

3. Identify where a programs version number is normally displayed.