Question

Why is documenting computer programs essential? Include in your discussion why you do or don't believe it regularly occurs? Provide at least one example.

Answer 1

Computer program documentation is very much important as reliable documentation is always a must. The presence of proper documentation helps to keep track of all aspects of an application and it also improves the quality of the code. Computer program documentation's main focus is on development, a better understanding of the code when passed to the next stage, and for the maintenance. Good documentation provides information accessibility easier, provides a limited number of user entry points, helps new users learn quickly, simplifies the product, and helps in cost for further improvements.

Advantages of Documentation

These are some of the advantages of providing program documentation −

• Helps in keeping track of all parts of a program.

• Easy to maintain.

• Other programmers who don't have any idea of the code can understand the logic used by reading the proper documentation.

• The quality of the code is improved as there are proper comments, functions, etc used.

• Helps to cut the maintenance cost later on.

Examples of different types of documentation made in computer programs.

• User manual − It describes instructions and procedures for end-users to use the different features of the software.

• Design Document − It describes design elements in detail. It documents details like data flow diagrams, entity-relationship diagrams, etc.

• Requirements Document − It has a list of all the requirements of the system as well as an analysis of the viability of the requirements. It can have user cases, real-life scenarios, etc.

• Technical Documentation − It is a documentation of actual programming components like algorithms, flowcharts, program codes, etc.

• Testing Document − It records the test plan, test cases, validation plan, verification plan, test results, etc.