Discuss all the different types of documentation and the various purposes they serve.

What will be an ideal response?


Program documentation is all of the written material that makes a program understandable. This includes internal documentation, which is part of the program code itself. Good internal documentation consists of choosing meaningful names for program identifiers, using plenty of comments to explain the code, and separating the program into short modules, each of which does one specific subtask. External documentation consists of any materials assembled to clarify the program's design and implementation. Although we have put this step rather late in the software development process, note that each preceding step produces some form of documentation. Program documentation goes on throughout the software development life cycle. The final, finished program documentation is written in two forms. Technical documentation enables programmers who later have to modify the program to understand the code. Such information as structure charts or class diagrams, descriptions of algorithms, and program listings fall in this category. User documentation helps users run the program. Such documentation includes online tutorials, answers to frequently asked questions (FAQs), help systems that the user can bring up while the program is running, and (less often) written user's manuals.

Computer Science & Information Technology

You might also like to view...

The end of the command line is indicated by

a: pressing the [Esc] Key b: pressing the period [.] key c: pressing the [End] key d: pressing the [Return] Key e: pressing the [Ctrl-d] key

Computer Science & Information Technology

Create the classes RightTriangle and Rectangle, each of which is derived from the abstract class ShapeBase in Listing 8.19. Then derive a class Square

from the class Rectangle. Each of these three derived classes will have two additional methods to calculate area and circumference, as well as the inherited methods. Do not forget to override the method drawHere. Give your classes a reasonable complement of constructors and accessor methods. The Square class should include only one dimension, the side, and should automatically set the height and width to the length of the side. You can use dimensions in terms of the character width and line spacing even though they are undoubtedly unequal, so a square will not look square (just as a Rectangle object, as discussed in this chapter, won’t look square.) Write a driver program that tests all your methods. This project is most easily written by modifying the programs in the text. Base RightTriangle.java on Triangle.java (Listing 8.14), Rectangle.java on Rectangle.java (Listing 8.13), and MoreGraphicsDemo.java on TreeDemo.java (Listing 8.15). Square.java is derived from Rectangle, so it is just a matter of using the parent’s methods with both height and width set to the length of the side of the square. Note that special attention is required to draw the correct figures when the base, width, or height values are either 0 or 1.

Computer Science & Information Technology

Case-Based Critical Thinking QuestionsCase 4-2Aaron is developing a Web site for the dinosaur exhibit at his local science museum. He has used separate layers to create an animation of a moving dinosaur. However, in the existing animation, the individual parts of the dinosaur-its head and tail, for example-remain stationary in relation to the dinosaur, and Aaron would like to animate the body parts so that the dinosaur moves more realistically. He asks you what approach you would recommend. You tell Aaron that within the Timeline of a movie clip symbol, it is possible to insert instances of other symbols that in turn can contain their own animations within their own Timelines. What is the term used for the symbols that are inserted?

A. child movie clips B. low-level movie clips C. subsidiary movie clips D. component movie clips

Computer Science & Information Technology

A large organization is more likely to use which type of network?

A) client/peer network B) peer-to-peer network C) client-to-client network D) client/server network

Computer Science & Information Technology