Question

Dialogue Question

Explain the importance of documenting within a program and steps you can take that will assist you in documentation. Consider and describe advantages of documenting compared to commenting in other aspects outside of computing and technology.

Response of 250-300 words only.

Answer 1

For a programmer reliable documentation is always a must. It is a important part because a documentation includes Requirements,architectural design. Requirements includes statements that identify the attributes or qualities of a system. Design includes the overview of software .Documentation is intended to help a user of software understand how to achieve their goal,but comments are intended to help someone who is maintaining the code understand the code.Comments are more related to contributors but documentations are related to users. A comment is a programmer-readable explanation that are added with the purpose of making the source code easier for humans to understand, and they are generally ignored by compilers and interpreters.A comment is often used to explain a small part of some code.A documentation is often focused on some third party user. This is usually more general and explains how to use something, not what a single statement does.

Documentation is having everything we need to know in one place and it is not everywhere in our code . The information in documentation is more general and tends to be like an overview whereas Comments are usually address specific technical details for sections like modules/functions or code blocks in a program.

Documentation is written for developers who want to apply the code to solve some problem.  But,comments are addressed to future developers or the one who is seeing the code ,who are likely trying to understand and modify the code.

Advantages of documentation:

• It determines what others need to know
• gives the proper method and style-the writing style of documentation should be based on the targeted audience.
• it is like a planning exercise which considers other benefits and applications
• Documentation is a form of communication so making good decisions about what to write ,document, the method style and process,all these are very important.
• Documentation acts as an audience materials which conveys the necessary details with proper styling .So every tasks within a project in any area requires careful consideration and documentation is no different,it is also a must.