IT Project Documentation best practices; the object of documentation

IT Project Documentation Best Practices are not simple because the purpose of the documentation is not always obvious. First, in an IT project, you can find a lot of different documentation; the famous user manual, the requirements documentation for the software operator, the architecture and design documentation for analysts, designers and developers and the technical documentation or software documentation for programmers are the main ones examples.

In short, Documentation is like insurance, you need it but you must find the right balance.

As far as we are concerned, we will talk about the architecture and design documentation and the technical documentation of an IT development project. So, what should we document?

In this series of posts, we will address the following points:

  • What should be documented in an IT project?
  • How should we document it?
  • Where should these documents be made available to different readers?