Ad
More Related Content
What's hot (20)
Similar to High level design document template (20)
Ad
Recently uploaded (20)
Ad
High level design document template
- 1. HLD Template Page 1 of 12 <> Project: High Level Design Template Department Name Date Version No. 1.00 Authorized by
- 2. HLD Template Page 2 of12 Confidentiality Agreement <Insert confidentiality clauses and Copy Rights> Revision History Version Date Author Reviewer Approver Comments 0.1 XXXXX Draft Version 0.2 XXXXX Incorporated some documentstructure and content related changes 0.3 XXXXX Added some sections like state and session management, caching etc. suggested by Laxmi R 1.0 XXXXX Baseline
- 3. HLD Template Page 3 of12 Table of Contents Introduction ...................................................................................................................................6 1.1 Scope of the document......................................................................................................6 1.2 Intended Audience............................................................................................................6 1.3 System overview...............................................................................................................6 System Design................................................................................................................................6 Application Design........................................................................................................................6 Process Flow ..........................................................................................................................6 Information Flow....................................................................................................................7 API Catalogue...............................................................................................................................8 Data Design ....................................................................................................................................8 Data Model ..................................................................................................................................8 Data Access Mechanism................................................................................................................9 Data Retention Policies.................................................................................................................9 Data Migration.............................................................................................................................9 Interfaces9 Non Functional Requirements ..................................................................................................10 Security Aspects ......................................................................................................................... 10 Performance Aspects................................................................................................................... 10 References....................................................................................................................................11
- 4. HLD Template Page 4 of 12 Introduction 1.1 Scopeof the document This section will cover details regarding scope ofthe document Sample Content: This document outlines the high level functional design of tax payer registration functionality. It highlights/refers the high level flows / Use cases in registration process, design of components, along with the rationale for the same. It serves as an input to the low level design documents that would further elaborate on the application design. 1.2 Intended Audience This section will cover categories ofaudiences who will be referring/reviewing this document Sample Content: Web portal DevelopmentTeam Architecture Team Quality Team Department 1.3 System overview This section will capture highlevel overview ofsystemapplication i.e. for whatsystem is being developed ,the high level process flow Who are the stake holders of system Sample Content: This system provides a web interface to the tax payer for filling up registration form and submits his registration request. This system also provides facility to integrate third party application through API so that tax payer can use third party application for registration. In Registration process, tax payer need to complete registration form having some mandatory and optional fields. This system will do the both structural validation and data validation in real time. There will be separate work flow for approval. System Design ApplicationDesign This section will capture Process flow,Information flow having sequence diagramfor different use cases, component design details, key design considerations taken and API catalogue Process Flow This section will capture theflowcharts(s) representing process diagram Sample Process Flow Chart: If we take tax payer registration work flow as a sample, Work flow diagram will be as shown in diagram
- 5. HLD Template Page 5 of 12 Information Flow This section will capture flow ofinformation between all application components required to meet the requirement This will capture flow for both positiveand negative scenarios Sam ple Sequence Diagram:
- 6. HLD Template Page 6 of 12 API Catalogue Sample Content: Sr. No. Name Of API Description Input Output Access Level 1 getNewRegistrationReq This Api provides the registration data As per input mentioned in API document availableat share point As per output mentioned in API document availableat share point Public 2 Data Design Data Model This section will capture high level design ofdata model It will capture information like whether it is RDBMS/HDFS etc. Entity relationship etc. diagrams will also be captured Sample Content:
- 7. HLD Template Page 7 of 12 Request_ID User_Name User_Address ID PK BNK.STMT_Request PK Request_ID User_ID BNK_Acc_Num Period_From Period_To Data AccessMechanism There will be a high level technical design consideration which will cover framework for data access mechanism i.e.ORM implementation details etc.In this section, any customization specific to module (for which this document is prepared) will be covered. Data RetentionPolicies This Section will capture policies related to data purging/data archiving This will also capturespecific tables for which datawill be purged/archived Data Migration This section will capture thedata migration strategy We know that data migration is big activity so the strategymay get capture in separate document. Ifit is being capturedin separate document, weneed to give thereference ofsame document. Interfaces This section will capture thehigh level details ofother Interfaces whichare interactingwith our application in scope. BNK.Request_Details
- 8. HLD Template Page 8 of 12 Non Functional Requirements This section will capture non-functional aspects of system This section will capture Security aspects and Performanceaspects ofthe system SecurityAspects Sample Content: Apart from infra level security (Web application firewall/Network firewall) here are somesample application level security considerations Virus scanning offiles before successful upload Symantec library will be usedas virus scanning engine Only selective File formatsupported Only *.docx,*.jpeg etc. .Fileformat are supported Restricted file upload size File size to be uploaded should not be exceeded to 5 MB PerformanceAspects This section will capture theperformanceaspects ofthe application in scope
- 9. HLD Template Page 9 of 12 References This section will list down thedocuments which has been refereedwhilecreating this document S.No Document Name Version Date