Technical documentation refers to any type of documentation that describes handling, functionality technical design and architecture of a technical product under development, requirements list etc. The intended recipient for product technical documentation is end user,administrator / service or maintenance technician, client... Technical documentation aims at providing enough information for a user to understand inner and outer dependencies of the product.
Most of the times technical design document is created in 2 parts. 1. High Level Design Document (HLDD), 2. Low Level Design Document (LLDD).
The HLDD contains the general overview of the architecture, components to be used in the program, details about the interaction with other applications, protocols to be used, security measure, reusable compon etc.
The LLDD contains every minute detail about the program that needs to be written like the database dictionary, method names, details of components, reusable components, how to reuse. Most importantly, it also contains the psuedo code as well.
Technical documentation may include:
patents
specifications of item or of components/materials
data sheets of item or of components/materials
test methods or test cases
Development standards followed
Quality management system requirements
information specified in laws or regulations
verification and validation
Quad charts
In webMethods we create TDD for Interfaces, Business flow or for a new process and include all webMethods objects used in development from flow services, adapters, triggers etc..and explain about technical flow and design. We include the logging details, external urls used, external system details, schema's, maps etc.
Leave a Reply
Guest User
Not sure what solution is right for you?
Choose the right one for you.
Get the help of the experts and find a solution that best suits your needs.
cabj4klt
hi friends what is meant by technical design documents
Monishy
Technical documentation refers to any type of documentation that describes handling, functionality technical design and architecture of a technical product under development, requirements list etc. The intended recipient for product technical documentation is end user,administrator / service or maintenance technician, client... Technical documentation aims at providing enough information for a user to understand inner and outer dependencies of the product.
Most of the times technical design document is created in 2 parts. 1. High Level Design Document (HLDD), 2. Low Level Design Document (LLDD).
The HLDD contains the general overview of the architecture, components to be used in the program, details about the interaction with other applications, protocols to be used, security measure, reusable compon etc.
The LLDD contains every minute detail about the program that needs to be written like the database dictionary, method names, details of components, reusable components, how to reuse. Most importantly, it also contains the psuedo code as well.
Technical documentation may include:
patents
specifications of item or of components/materials
data sheets of item or of components/materials
test methods or test cases
Development standards followed
Quality management system requirements
information specified in laws or regulations
verification and validation
Quad charts
In webMethods we create TDD for Interfaces, Business flow or for a new process and include all webMethods objects used in development from flow services, adapters, triggers etc..and explain about technical flow and design. We include the logging details, external urls used, external system details, schema's, maps etc.