Names Agreements – this section determines what to call functions, variables, constants and global variables.
The indent is a gap left at the beginning of the line, usually 2-8 gaps or one tab.
Spaces – are usually not indicated at the end of the line.
Operators – defines the rules for writing mathematical, assigning and logical operators. For example, the assignment operator ‘=’ must have a gap to and after it, as in “x = 2”.
Managing structures are the rules for writing iF-teen -else, Case-Switch, While-Byfore and for operators of the control flow exclusively and in the applied form.
Line length and transfer – determines how many characters should be in one line, mainly the length of the line is 80 characters. The flow determines the method of transferring the line if it is too long.
Functions – this determines how the functions should be declared and caused, with parameters and without parameters.
Variables. It indicates how variables of various data types are declared and determined.
Comments are one of the important components of coding, since the comments included in the code describe what the code actually makes and all other related descriptions. This section also helps to create reference documentation for other developers.
Software documentation
Program documentation is an important part of the software process. A well -written document provides an excellent tool and means for storing information necessary to understand the software development process. Software documentation also contains information on how to use the product.
Well -groomed documentation should include the following documents:
Documentation on the requirements – this documentation is a key tool for the software developer, developer and testing group to perform relevant tasks. This document contains all the functional, non -functional and behavioral description of the alleged software.
The source of this document may be previously saved software data, already neglected software on the client’s side, client interviews, questionnaires and research. As a rule, it is stored in the form of a spreadsheet or a document for processing texts with a team of high -class software management.
This documentation serves as the basis for software development and is mainly used at the stages of verification and validation. Most test cases are built directly from the documentation of the requirements.
Software development documentation – this documentation contains all the necessary information necessary for creating software. It contains: (A) Architecture of high -level software, (b) Details of software development, (C) data flow diagrams, (D) database design
These documents work as a storage for developers for the implementation of software. Although these documents do not contain any details on how to encode the program, they provide all the necessary information necessary for coding and implementation.
Technical documentation. These documents are supported by developers and existing programmers. These documents, in general, present information about the code. When writing code, programmers also mention the goal of the code, who wrote it, where he needs, what he does and how he does, what other resources the code uses the code, etc.
Technical documentation improves understanding between different programmers working on the same code. This increases the capabilities of reuse of code. This makes the debugging light and tracked.
Various automated tools are available, and some are supplied with the programming language itself. For example, Java comes with a Javadoc tool to create technical documentation.
User documentation – this documentation differs from all of the above. All previous documents are supported to provide information about the software and the process of its development. But user documentation explains how the software product should work and how to use it to get the desired results.
These documents may include software installation procedures, practical guidelines, user manuals, removal method and special links for additional information, such as license updating, etc.
Problems of software implementation
There are some problems faced by a team of developers in the implementation of software. Some of them are mentioned below:
Re -use of code. Programming interfaces of modern languages are very complex and equipped with huge library functions. Nevertheless, in order to reduce the cost of the final product, the organization’s management prefers to re -use the code that was created earlier for some other software. There are huge problems that programmers face to check compatibility and solution, how much code is reusable.
Management of versions – every time the client is issued new software, the developers must conduct documentation related to the version and configuration. This documentation should be very accurate and accessible on time.
Target-Host-the software that is being developed in the organization should be developed for hosts on the client side. But sometimes it is impossible to develop software that works on target machines.
Re -use of code. Programming interfaces of modern languages are very complex and equipped with huge library functions. Nevertheless, in order to reduce the cost of the final product, the organization’s management prefers to re -use the code that was created earlier for some other software. There are huge problems that programmers face to check compatibility and solution, how much code is reusable.
Management of versions – every time the client is issued new software, the developers must conduct documentation related to the version and configuration. This documentation should be very accurate and accessible on time.
Target-Host-the software that is being developed in the organization should be developed for hosts on the client side. But sometimes it is impossible to develop software that works on target machines.