Concepts of Programming Methodology
Programming is basically solving a particular problem by giving coded instructions to the computer. Furthermore, the whole scenario of the programming cycle involves writing, testing, troubleshooting, debugging, and maintaining a computer program. Moreover, a good program should have clarity and simplicity of expressions, should make use of proper names for identifiers, contain comments, and have a proper indentation and documentation.
Programming Process Cycle
The steps of programming are as follows:
Writing
This step involves writing the desired output of the code. besides, drawing a flowchart depicting all the steps from beginning to end. Then the programmer writes the first copy of the code on the programming software.
Testing
This step is about testing the code against the test cases. If the output is according to desired test cases, the code is correct.
Troubleshooting
After testing the program we perform the error correction in this step.
Debugging
It is the process of finding the exact location of the error in the code.
Running
After all these steps the program is run to get the desired output.
What is an efficient program?
A program that gives the correct desired output for every input, including the wrong input is efficient. Moreover, it should produce correct results in less time and use less memory space. Besides, an efficient program should have clarity and simplicity of expressions, should make use of proper names for identifiers, contain comments, and have a proper indentation and documentation. Here, we will study the documentation in detail.
Documentation
Documentation basically helps an inexperienced user to prepare the input, process the code, and obtain the output. Besides, this includes the problem definition, design documentation, history of program development, description of test performance, versions of the program, and a user’s manual.
Requirement of Documentation
When we develop big software the program code is excessively long. Such codes are not developed by a single programmer. Therefore, we break the program into various modules. Since different programmers developed these modules therefore we require proper documentation. Furthermore, in this manner, everyone can read and understand the code easily. Hence, it is an important part of programming.
Browse more Topics Under General Concepts of Programming Methodology
- Clarity and Simplicity of Expressions
- Use of Proper Names for Identifiers
- Comments
- Indentation
- Program Maintenance
- Running and Debugging Programs
- Syntax Errors
- Run-time Errors
- Logical Errors
Rules of Documentation
We should always provide the documentation according to the reader’s perspective. Therefore, there are certain guidelines to follow. They are as follows:
- We should avoid repetition.
- It should not be ambiguous.
- We should update it from time to time.
- Follow the industry standards.
- We should remove or update the outdated documents.
Types of Documents
There are certain types of documents as follows:
User Manual
This is basically a ‘how to use’ manual for inexperienced users.
Operational Manual
It contains the operations and their respective dependencies.
Design Document
It contains the design aspects of the program. Moreover, it contains flow charts, data flow, entity-relationship diagrams, etc.
Requirement Document
It enlists all the requirements to run the software correctly.
Technical Document
It contains the program code, algorithms, functional modules, etc.
List of known bugs document
It contains a list of such bugs or errors which were discovered after the completion of software and hence, cannot be corrected.
Advantages of Documentation
- Makes it easy to maintain the code.
- Ease the user-training.
- Readability improves for developers as well as others.
- We can track the whole program which is in the form of different modules.
- The quality of software becomes better.
- If a programmer leaves the software in the middle the new programmer can understand the code easily.
Frequently Asked Questions (FAQs)
Q1. What is programming?
A1. Programming is basically solving a particular problem by giving coded instructions to the computer.
Q2. What are the steps of writing a successful program?
A2. The whole scenario of the programming cycle involves writing, testing, troubleshooting, debugging, and maintaining a computer program.
Q3. What is the documentation?
A3. Documentation basically helps an inexperienced user to prepare the input, process the code, and obtain the output.
Q4. Why do we need documentation?
A4. We need it to increase the readability. Besides, it makes the program easy to read and use. Moreover, any new programmer can understand the old code easily.
