Scribd
Upload
54 views5 pages

5.0. Languages of Implementation.: 3.3overall Description

This document outlines the structure and contents of a project documentation report. It includes sections for an abstract, introduction, system analysis and description, software requirements specification, languages of implementation, software design, code, testing, deployment, conclusion, and future enhancements. Key subsections under software design involve use case, class, sequence, state, and activity diagrams. Database design includes normalization, ER diagrams and table descriptions. Testing involves unit, integration, white box and black box strategies. Code examples and screenshots are provided.

Uploaded by

krishnashekhar10
Copyright
© Attribution Non-Commercial (BY-NC)
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as DOCX, PDF, TXT or read online on Scribd
54 views5 pages

5.0. Languages of Implementation.: 3.3overall Description

This document outlines the structure and contents of a project documentation report. It includes sections for an abstract, introduction, system analysis and description, software requirements specification, languages of implementation, software design, code, testing, deployment, conclusion, and future enhancements. Key subsections under software design involve use case, class, sequence, state, and activity diagrams. Database design includes normalization, ER diagrams and table descriptions. Testing involves unit, integration, white box and black box strategies. Code examples and screenshots are provided.

Uploaded by

krishnashekhar10
Copyright
© Attribution Non-Commercial (BY-NC)
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as DOCX, PDF, TXT or read online on Scribd
You are on page 1/ 5

Table of Contents

1.0. ABSTRACT

2.0. INTRODUCTION(REQUIREMENTS GATHERING)

2.1. Purpose

2.2 Scope
2.3 Goals/ Aim
2.4 Features of ur project ( Advantages)

3.0. SYSTEM ANALYSIS AND DECRIPTION

3.1. Existing system Or Background Work

3.2. Proposed system

3.3Overall description
3.4 Modules & Functionalities Description at Low Level – This is major part where we need to have in
the document. Almost 30% of the document should be this.

3.5. Feasibility Study

3.6 SDLC Model.

4.0. SOFTWARE REQUIREMENT SPECIFICATIONS

4.1 Software interfaces


[If it is web HTTP and IIS. And if it is DB project TCP/IP. If we use any other protocols
please mention them with some description.]

5.0. Languages of implementation.


Dot net Description and Concepts we are using in this project – 10pages

6.0. SOFTWARE DESIGN

6.1 Design Overview ( Software arch and Application arch)

6.2 UML Design (Use case, Sequence, Class , state, activity, collaboration also)

6.3 DFD Design.

6.4 DB Design (includes normalization theory, ER-diagram, Tables / Fields description) We have a
standard table for this.

Eg:

Table Name: <<RegTable>>

S.n Field Name DataType (Size) Constraints [P.K,


o F.K,
NULL,Check etc]

6.5) User Interfaces or Output Screens. [All screen shots include Validations screens]

Flow of Screens should be as below.

Module Wise and Role Wise.

EG:

User Screens:

Fig: 1
Description: User Registration form. Here We will collect the information about the
user. User has to fill the below fields

 First name [Mandatory]


 Last Name [Not Mandatory]
 Username [Mandatory]

Etc [All fields should be mentioned.]

After entering all once he clicks on submit button All the fields are stored in RegTable
using stored Procedure <<Sp_InsertUser>>

Description about each screen at field level

7.0 Code [5-7 pages]

Pseudo code Explanation And place the code in box

EG:

a. Functionality Name:
Explanation: The below code prints 10 numbers

For(int I =0; i<10;i++)


{
………
…………..
……….

}
8.0. TESTING [Just include introduction for 5 pages) Write Test cases for all projects. Minimum of 30
Test cases should be there.

7.1 Testing Introduction

7.2 Unit Testing

7.3 White Box Testing

7.4 Black Box Testing

7.5 Integration Testing

7.6 Test Cases

9 Deploying

9.1 Running Application [Include Screen shots to deploy it]

9.2 Configuring Data Base [Include screen shots to configure it]

9.0. CONCLUSION [Minimum of 1page should be there]

10.0 FUTURE ENHANCEMENT [Propose Min 2 enhancements for future.]

11.0 BIBLIOGRAPHY

References:

Follow Harvard References Styling

EG:

H.E. Gruber & J. J. Vonèche [Eds.], The Essential Piaget, Basic Books, 1977

[2] Computing Curricula 2001, The Joint Task Force on Computing Curricula,
Final Report, IEEE Computer Society, Association for Computing Machinery,

Dec 15, 2001

[3] IEEE Std. 829-1998 IEEE Standard for Software Test Documentation

[4] IEEE Std. 830-1998 IEEE Recommended Practice for Software Requirements

Specifications

[5] IEEE Std. 1008-1997 IEEE Standard for Software Unit Testing

[6] IEEE Std. 1012-1998 IEEE Standard for Software Verification and Validation

[7] IEEE Std. 1016-1998 IEEE Recommended Practice for Software Design

Descriptions

[8] IEEE Std 1058-1998 IEEE Standard for Software Project Management Plans

[9] IEEE Std 1540-2001 IEEE Standard for Software Life Cycle Processes – Risk

Management

[10] IEEE 12207.2-1997 Industry Implementation of International Standard

ISO/IEC 12207: 1995 (ISO/IEC 12207) Standard for Information Technology -

Software Life Cycle Processes - Implementation Considerations

[11] E.F. Lindquist (Ed.), Educational Measurement, American Council on

Education, 1951

[12] R. McCauley and U. Jackson, "Teaching Software Engineering Early –

Experiences and Results", in Proceedings of the 1998 Frontiers in Education

Conference (FIE'98), IEEE, 1998.

[13] R. Thomas, G. Semeczko, H. Morarji, G. Mohay, "Core Software Engineering

Subjects: A Case Study ('86 - '94)", in Proceedings of the Software Education

Conference 1994, Pages: 24-31, IEEE, 1995

You might also like