answersLogoWhite

0

Program documentation is an essential part of any computer program or application. The documentation specifies what each part of the code does, what events will be triggered during the course of the program, and makes sure that no part of the program is accidentally left off the interface or code.

User Avatar

Wiki User

11y ago

What else can I help you with?

Continue Learning about Engineering

What is A program that has its own documentation called?

comments


What approach opens an application program and then creates a document?

documentation-centric approach


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


Define documentation section of a c program?

The different sections of a program are: 1. Heap 2. Stack 3.Data segments 4. Read only area 5. Code You can also look into google for more information http://en.wikipedia.org/wiki/Data_segment


What is the difference between user documentation and system documentation?

User documentation demonstrates how to best use the product. A system documentation is considered more of a user manual, which is very straightforward, with no opinion.

Related Questions

Which documentation is typically written first input output internal program or external program?

Output documentation


How do you put documentation in a sentence?

Often, documentation for a software program is called Help.


What is A program that has its own documentation called?

comments


What is the difference between internal and external documentation?

Internal documentation is the one in which various information regarding the program is enlisted in the program itself i.e. in the form of comments. On the contrary, external documentation is the one that is prepared separately to inform the users about the system.


What Is the collection and summarization of written descriptions of what a program does and how to use it?

The collection and summarization of written descriptions of what a program does and how to use it is typically referred to as documentation. Documentation provides information on a program's functionality, features, usage instructions, and often includes examples to help users understand how to interact with the software effectively. Good documentation is essential for users, developers, and other stakeholders to comprehend the program's capabilities and functionalities.


What approach opens an application program and then creates a document?

documentation-centric approach


How is a C program compiled?

With a compiler. Read the documentation for programming package for help on how to.


How compiler compile a program?

With a compiler. Read the documentation for programming package for help on how to.


How do you improve debugging knoweldge in c program?

Read the documentation, and practice a lot.


What has the author Frank Gulino written?

Frank Gulino has written: 'Technical documentation for GBF/POLYGON' -- subject(s): Geographical location codes, Documentation, Data processing, POLYEDIT (Computer program), POLYCODE (Computer program)


What documentation is required as proof of residency for the Global Entry program?

To apply for the Global Entry program, you need to provide documentation such as a driver's license, state ID card, or a utility bill that shows your current address as proof of residency.


What should be included in your documentation?

What works for most people is the person who has just bought your program has no idea how to use the program to its best advantage. The documentation should contain enough information for the user to work how to use the program without confusing the user.