Java Projects - Second Edition

Documentation

Documentation is an important aspect. If the documentation is not appropriate, it will be hard to learn how to use the library. Some of the team members may already know the library, but, again, this may not be the case for newer team members. We should consider our colleagues, who are expected to be average programmers, as they will have to learn to use the library. Thus, documentation is important.

When we speak about documentation, we should not only think about the JavaDoc reference documentation but also tutorials and books if they are available.