answersLogoWhite

0

What else can I help you with?

Continue Learning about Engineering

What is the importance of documentation in programming life cycle?

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


What is the importance of cloves?

what is the importance of cloves


Importance of research to national development?

Research is important to national development because it can help predict certain events that can affect development. Research can help with the national planning process to determine areas that can be improved and activities that need to be discouraged.


What is the importance of technical writing?

== == One common belief in the global software industry is that, if a program is well designed or well written, it won't need any software documentation. But, as we often se this belief has been proved to be nothing more than hot air. Technical documentation is essential for the smooth functioning of a company. Technical Documentation Services comprises of all activities, means and systems that provide information on how to use a product. This information in turn enables the user to understand the functioning of the product and to handle, maintain, repair and dispose it correctly and safely. Also, in the absence of good and clear documentation written, either by your own company or a technical writing service, your IT staff will end up spending more time dealing with trying to solve technical problems. And this in turn leads to more work and waste of a lot of time that could have been better utilized. And all businesses, large or small, need well-written technical documentation to operate efficiently. Therefore most companies hire technical documentation writing services, especially technical writing services of India, to make the whole process easier for them. However, if end-users feel that the technical documentation is too hard to learn, not easy to use, or too cumbersome, then it will not be effective or useful. So, the importance of good technical documentation writing services in India shouldn't be underestimated. A good technical writing service in India should make a product easy to understand and use, resulting in greater user acceptance. Different companies outsource technical writing services to India for different purposes. Some companies that make products or software outsource technical writing services to India for technical manuals and user guides that'll explain the how to properly use the product. For example, manuals for computer printers; fax machines, modems etc. these are intended for both customers as well as internal use. Most of the time, technical guides and manuals written by technical writing services include quick reference guides that provide organized reference during the use of a hardware or software, software user guides providing instructions on how to use a software product, and hardware installation guides and repair guides that give information on the various features and functions of a hardware product as well as how to install, modify, maintain or repair the piece of hardware. Sometimes there are even user guides that supply instructions on how to use a hardware product and how to modify or program its hardware/software. You can also use the technical documentation written by an offshore technical writing service as a marketing tool, to share valuable information and strengthen the lines of communication between IT and the end-users. However, effective technical documentation written by any technical writing service will take some time and effort, but in the long run, its worth it.


Importance of statistics in the field of welding?

what are the importance of statistics to welding

Related Questions

What are the care and control procedures for the documents and what is the importance of returning them to the designated location on completion of the work activities?

Lizard eat bugs...


What is the importance of office equipment?

To help with the completion of daily activities


What is the Importance of returning documents to the designated location on completion of the work activities?

Returning documents to the designated location after completing work activities is important for organizational efficiency and transparency. It ensures that important information is properly stored and easily accessible for future reference or audits. This practice also helps maintain data integrity, confidentiality, and compliance with any document retention policies in place.


What is the importance of documentation in shipping?

Documentation in shipping plays a number of roles. In some cases, the shipped package won't even be accepted by the designated recipient if he or she cannot determine what is being shipped. The accounts payable department (or whomever pays the bills) will not know what to pay, unless there is shipping documentation. If the shipping crosses an international border, the customs agents will want to see documentation or they may not allow the package to pass through the border.


What is the importance of the chain of command?

to insure the completion of goal


What is the importance of statistics in our lives?

appraise the importance of statistics to human activities


What is the primary goal of discipline?

To teach responsibility, the importance of task completion and self-discipline by example.


Why it is important that to complete documentation?

I can explain the importance of documentation with a simple example below i think it should answer your question. So consider we have a project to be done we first then start with the documentation specifying the step to step process of what should be done and it goes on like that and the modifications are done accordingly as we move further and complete the documentation successfully. Now any one can understand the project by the documentation as it involves step by step procedure of what is being done in a particular project. If we don't have the documentation or well maintained documentation and suppose we left the project incomplete and it should be done by somebody else ,due to improper documentation he/she suffers a lot to understand the early stages of the project, so either he/she had to start the project from starting which is a very time taking process or we can say it's waste of time or he/she should make up their so that they understand the documentation to proceed with the project which is i can say impossible. so the documentation plays a vital/important role for the sucessful completion of a particular project.


What is the meaning and importance of co-curriculum activities?

yes


What is the meaning and importance of co curriculum activities?

yes


What is the importance of self testing activities?

I dnt know


What does High and Low importance?

High importance refers to tasks or activities that are crucial or essential. Low importance refers to tasks or activities that are less critical or can be completed at a later time. Prioritizing high importance tasks over low importance tasks helps ensure that the most critical work is completed first.