Why do you need Documentation?

Answer 1

The best way I can explain this is to give you an example of code with no documentation. If there was documentation, you would be able to tell what this code did in a matter of seconds. Without it you could waste many minutes, or even hours, trying to understand it.

inline unsigned char f_1(const unsigned char *ptr, const unsigned int i) {

const div_t d = div(i, 8);

return (ptr[d.quot] & (1 << d.rem))?1:0;

}

inline void f_2(unsigned char *ptr, const unsigned int i) {

const div_t d = div(i, 8);

ptr += d.quot;

*ptr = *ptr | (1 << d.rem);

}

inline void f_3(unsigned char *ptr, const unsigned int i) {

const div_t d = div(i, 8);

const unsigned char n = 1 << d.rem;

ptr += d.quot;

*ptr = ((*ptr | n ) ^ n);

}

void f(const unsigned int n) {

const unsigned int m = n + (n%8==0?0:8-n%8);

const unsigned int n = m / 8;

const unsigned int m_2 = m / 2;

unsigned int i, j;

unsigned char *a = malloc(sizeof(unsigned char) * n);

memset(a, 0xaa, n);

f_3(a, 1);

f_2(a, 2);

for( i = 3; i < m_2; i+=2 ) {

while(i < m_2 && !f_1(a, i))

i+=2;

for( j = i + i; j < m; j+=i )

f_3(a, j);

}

free(a);

}

Answer 2

Source documents are an essential part of recording entries. These documents are the backup for entries to ensure that the correct information has been input into the computer system. Examples of source documents are invoices that Accounts Payable would input into their accounting system to generate payment.

Answer 3

While most developers prefer to avoid documentation, as it isn't very stimulating, it's a critical part of any engineering project, especially for software. Documentation provides information that is useful for the user of the product to understand the parameters under which it is to function properly, and is to be used. It can provide insight into management as to what the scope of functionality is for the product, should they decide to extend that functionality or revamp it at some point as technologies change. It also serves as a sort of "soft" blueprint (not as useful as the source code or flow diagrams, but still useful) to software engineers/developers to go back and fix any bugs that may exist, but still keep the software working within initial design or acceptance criteria (for QA).