0
Documentation is critical unless you are the only person who will ever, ever, ever look at a piece of code. And even then, if you go away from it for 6 months you will probably have trouble remembering what you did.
In business, code MUST be commented because the person fixing or enhancing the program is often not the person who wrote it. It can take 4 or 5 times as long to figure out what a program is doing when you only have the computer-language logic available, as opposed to an English-language explanation of the underlying concepts.
It's also critical to keep the documentation up to date and accurate in both facts and spelling. If the code has been changed and the documentation hasn't, that disagreement can mislead anyone who comes along and tries to work on the code later. If you can't spell or use lousy grammar, it can make it a lot harder to perform text searches looking for a particular phrase that's likely to appear in a comment. Try searching for PARAMETER when somebody spelled it PARAMATER, for example (I've had to do just that!!)
The above is an explanation to why documentation is important in one of levels of software documentation - Technical or Code Documentation. There are other levels of documentation including Software Requirements Documentation, Software Architectural/Design Documentaion and End-User Documentation (e.g.: Manuals, Tutorials). Documentation at each of these levels is usually necessary, or at least desired, for most non-trivial software projects. For more information on these levels of documentation and to who and how it may be important, pls see http://en.wikipedia.org/wiki/Software_documentation
Internal documentation gives the programmer a chance to communicate to other programmers thru comments. There are two types of comments header Comments and Step Comments. Header comments appear at the beginning of the program and can tell who the programmer was, what company they work for and what the program is supposed to do. The Step comments can be all thru out the program and explain to others about specific portions of the program.
You can see what you have done and what you still have to do
The people you are working for know what you have completed and therfore what they have to pay you for doing.
End users of the program especially know what has been done so if it breaks then theyknow what broke and how to fix it
Add your answer:
Earn +20 pts
Importance of programming in system development?
When business organization facing a keen (鋒利的) competition in the market, rapid change of technology and fast internal demand, system development is necessary. In the system development, a business organization could adopt the systematic method for such development. Most popular system development method is system development life cycle (SDLC) which supports the business priorities of the organization, solves the identified problem, and fits within the existing organizational structure. When business organization facing a keen (鋒利的) competition in the market, rapid change of technology and fast internal demand, system development is necessary. In the system development, a business organization could adopt the systematic method for such development. Most popular system development method is system development life cycle (SDLC) which supports the business priorities of the organization, solves the identified problem, and fits within the existing organizational structure.
Brief description of object oriented life cycle?
object oriented life cycle
How does a project life cycle differ from a product life cycle?
The product life cycle represents the amount of revenue a product generates over time, from its inception to the point where it is discontinued. A project life cycle measures the work that goes into a project from beginning to end. The phases in product life cycle are initiation, planning, execution, and closure.
What are the steps in product life cycle management?
The steps may vary to one life cycle to another.The main steps are requirements specification, designing, coding, testing and maintenance.
What is the difference between system development life cycle and prototype?
A System Development Life Cycle is the process of developing a system or software. Prototype is the process of creating examples of software applications,
During which phase of the system development life cycle does the actual programming occur?
development and documentation
What is the importance of cardiac cycle?
The importance of cardiac cycle is to sustain human life.
What is the importance of knowing the life cycle in the production of crop?
The importance of knowing the life cycle in the production of crops is that the farmer needs to know when to plant and when to harvest a crop. The growing season differs from one plant to another.
What is the purpose of the systems development life cycle in computer programming?
The purpose of systems development life cycles in computer programming is to write code to solve a problem. These cycles are essential in the maintaining of computer information.
What are the zoological importance of a frog?
it eats insect it is imp member of environment life cycle
What are some responsibility of development life-cycle?
To manage any changes made to a software application, from planning and documentation to implementation and quality testing.
What is the economic importance of ants?
The economic importance of ants in the life cycle of an ecosystem is helping the decomposing clean up of dead organisms or organic debris.
What is the importance of seed in the life cycle of plant?
The seed is where the mitosis starts if given the nutrition to start the cycle. Then the cells splits up faster than American marriages.
What is the importance of the organizational stage in the life cycle of the business?
Management of every organization has to play an integral role during every stage of organizational life cycle. Organization has to undertsand where they are standing by scanning their life cycle.
What is the importance of the Demeter in Dracula?
Demeter was among other things the Goddess of the cycle of life and death. The ship Demeter brings Dracula to his victims speeding up that cycle or altering it.
What are the seven Characteristics of successful project?
Importance Scope Life cycle with a finite due date Interdependencies Uniqueness Resources Conflict
What is the importance of the title in the book the law of life?
The title "The Law of Life" symbolizes the natural cycle of life and death, which is a central theme in the story. It emphasizes the inevitability of death and the importance of accepting one's fate. The title also sets the tone for the narrative's exploration of life's fleeting nature and the inevitability of mortality.
