Transcription
Low Level Design TemplateProject Name Date Version No.1.00Authorized byLow Level Design TemplateP a g e 1 16
Confidentiality Agreement Insert agreement summary here Revision HistoryVersion DateAuthorReviewerApproverComments0.1XXXXXDraft Version0.2XXXXXSuggested some sectionslike key notes, screenvalidations andattributes to be added0.3XXXXXSuggested documentformat relatedcomments likecorrection of version,adding one section foropen issues etc.0.4XXXXXSuggested some changeslike correct sequencediagram, changes indata design sections etc.1.00XXXXXBaseline versionLow Level Design TemplateP a g e 2 16
Table of Contents1. Introduction . 61.1Scope of the document . 61.2Intended Audience . 61.3System overview . 62. Low Level System Design . 72.1Sequence Diagram . 72.2Navigation Flow/UI Implementation . 72.2.1Screen Validations, Defaults and Attributes. 72.3Client Side Validation Implementation . 82.4Server Side Validation Implementation . 82.5Components Design Implementation. 82.6Configurations/Settings. 92.7Interfaces to other components . 93. Data Design . 103.1List of Key Schemas/Tables in database . 103.2Details of access levels on key tables in scope . 103.3Key design considerations in data design . 104. Details of other frameworks being used . 114.1Session Management . 114.2Caching . 115. Unit Testing .126. Key notes .137. References .14Low Level Design TemplateP a g e 3 16
Index of TablesNo table of contents entries found.Low Level Design TemplateP a g e 4 16
Index of FiguresNo table of contents entries found.Low Level Design TemplateP a g e 5 16
1. Introduction1.1 Scope of the document This section will cover details regarding scope of the documentLow level design document will be at component level i.e. for Website portal there will beOne LLDSample Content:This document outlines the Low level design of tax payer registration functionality. Ithighlights/refers the Use cases in registration process and low level design details of componentsalong with the rationale for the same. This document is reference design document fordevelopers/implementers so that they can develop system with minimal effort1.2 Intended Audience This section will cover categories of audiences who will be referring/reviewing thisdocumentSample Content: Web portal Development TeamArchitecture TeamQuality TeamIRD Department1.3 System overview This section will capture overview of system application i.e. for what system is beingdevelopedWho are the stake holders of systemWhat are other external systems through which this will be interactingLow Level Design TemplateP a g e 6 16
2. Low Level System Design Low level design/implementation approach will be captured2.1 Sequence Diagram This section will capture flow of information between all application layers required tomeet the requirementSequence diagram is input for low level design of componentsSample Sequence Diagram:2.2 Navigation Flow/UI Implementation This section will capture the navigation flow i.e. How different screens/pages are beingdisplayed depending upon different conditions involved in implementationThis will provide visualization to developer/implementer for integration of differentviews/pages In the flowThis section will also include/reference the screen layouts/wireframes2.2.1 Screen Validations, Defaults and AttributesThis section will capture the validations, default values of fields which has not been covered in SRSLow Level Design TemplateP a g e 7 16
2.3 Client Side Validation Implementation This section will capture the implementation approach for handling client sidevalidationsSome code snippets for implementation of client side validation i.e.JS frameworks basedimplementation can be captured In this section2.4 Server Side Validation Implementation Server side validations should also be there in any web portal apart from client sidevalidation as attacker can disable java script in the browserThis section will captured the implementation approach for server side validations2.5 Components Design Implementation This section will capture low level design of the components(in different layers) involvedin sequence diagramHere components are being referred for set of independent implementations which canbe integrated to achieve complete functionality. For example: Web portal can haveuser authentication component, digital signing component, component for caching data,email/SMS messaging client component, components for validation of user data fromCBDT database, MCA DB and UAID DB2.5.1 Component 1A. Class Diagram This will list down all the classes involved for implementing the componentThis also depicts relationship of different classesMore details on classes for particular component can be found in java documentLow Level Design TemplateP a g e 8 16
B. Pseudo CodeThis section will capture the pseudo code for algorithms (if any) involved inimplementation of component.C. Other Implementation DetailsThis section will capture other implementation details which has not been covered underabove mentioned heads2.5.2 Component 22.6 Configurations/SettingsThis section will capture the details of different settings/configurations being used insystem applicationSample Content:All the configuration of different parameters will be stored in properties file in the form of keyvalue pair. This property file will be loaded to server during start-up2.7 Interfaces to other componentsThis section will capture the design details of interfaces to other components.Low Level Design TemplateP a g e 9 16
3. Data Design3.1 List of Key Schemas/Tables in databaseThis section will capture the details for list of key schemas/tables through which module inscope is interacting.3.2 Details of access levels on key tables in scopeThis section will capture the access level i.e. Read, insert, update etc. details of module on keytables/schemas3.3 Key design considerations in data designThis section will capture the key design considerations taken while designing the datamodel/selecting the data access mechanism etc.Low Level Design TemplateP a g e 10 16
4. Details of other frameworks being used4.1 Session Management This section will capture the details for list of fields which are being stored in sessionThis section will also captures the details like session expiry time, which page need to bedisplayed when if session get expired/invalidated4.2 Caching This section will capture the details like what are the key fields of tables which are beingcachedThis will also capture details like whether data is being stored in local cache or indistributed cacheThis will also capture caching expiry time etc.Low Level Design TemplateP a g e 11 16
5. Unit Testing This section will capture the details for list of unit test cases being used for testingparticular componentReference of unit test case document can be given in this sectionLow Level Design TemplateP a g e 12 16
6. Key notesThis section will elaborate on exception handling, any assumptions, and any other constraints thatwere not covered in above sections.Low Level Design TemplateP a g e 13 16
7. ReferencesThis section will list down the documents which has been refereed while creating thisdocumentS.No.Document NameLow Level Design TemplateVersionDateP a g e 14 16
Appendix 1. Comments MatrixSince there is no formal tool finalized currently for logging comments on various documentdeliverables, Comments Matrix is being put here to ensure comments are being tracked andresolved. Once a formal tool is identified, this process might change for future deliverables.S. No.DepartmentReviewCommentsDate RaisedVendorRemarksStatus12Low Level Design TemplateP a g e 15 16
Appendix 2. Open IssuesThis section should list the open issues which have not been resolved at the time of submission of thedocument for review.ID Item1Low Level Design TemplateResponsibilityStatusVendor/Department OpenP a g e 16 16
Low Level Design Template P a g e 6 16 1. Introduction 1.1 Scope of the document This section will cover details regarding scope of the document Low level design document will be at component level i.e. for Website portal there will be One LLD Sample Content: This document outlines the Low level design of tax payer registration functionality.
