Integrated Design document (IDD) speaks about the design and
architecture of a module in the proposed Application or System in detail. Its
main focus would be on the integration aspects with other modules. If the
module is a service then it should explain the interface that will be exposed
to all the clients so as to use the service. If the module is a client then it
explains all the services used to perform the operations. IDD also gives a
brief on the total application if the module is targeted to a particular
application in general. It is to be noted that IDD document is generally
prepared for generic components or reusable components. Let us discuss the
contents of the IDD document.
1.
Introduction – Brief of what the Module does.
2.
Architecture Description – A Diagram consisting of all the components in
the Module showing how they are interacted with each other supported with a
verbal explanation. This section can also have the design patterns followed and
an explanation towards the same.
3.
Proposed Application – It explains what kind of application can use this
module.
4.
Interfaces exposed – To use this module as a service, the interfaces are
exposed by the module. It also explains the configuration settings with some
real time examples. This is the most important section as this deal with the
integration with other modules.
5.
Dependency of other modules – A module can consume another module. For example,
Exception framework consumes logging framework. Exception uses logging to log
the exceptions. Such kinds of dependencies are illustrated here.
6.
Database Design with all the Tables – In case a module is using a
database, the design of the database is explained in brief.