What makes a good developer / system documentation?

Posted by deamon on Programmers See other posts from Programmers or by deamon
Published on 2011-03-15T17:04:38Z Indexed on 2011/03/16 0:18 UTC
Read the original article Hit count: 336

Filed under:

Much time is wasted to get new developers started with existing software systems, because there is no good documenation. But what makes a system documentation good? One thing is a good API documentation like the Java API doc, but how to transfer the "bigger picture" and other things that cannot be placed in the API doc?

One constraint is that it should not be to hard and time consuming to write the docs, because that is one reason why it is omitted so often.

So, what makes documentation good?

© Programmers or respective owner

Related posts about documentation