Scribd
Upload
274 views6 pages

Document Templates For Software Engineering Projects

This document outlines templates for core software engineering documents, including a Software Project Management Plan, Software Requirements Specifications, Software Design Description, and Software Test Documentation. It describes the purpose and typical contents of each document type to guide students in developing documentation for their software engineering projects in a standardized way. Common sections like cover pages, revision histories, and additional materials are also defined for inclusion across all document types.

Uploaded by

Ma. Sheila Magboo
Copyright
© © All Rights Reserved
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
274 views6 pages

Document Templates For Software Engineering Projects

This document outlines templates for core software engineering documents, including a Software Project Management Plan, Software Requirements Specifications, Software Design Description, and Software Test Documentation. It describes the purpose and typical contents of each document type to guide students in developing documentation for their software engineering projects in a standardized way. Common sections like cover pages, revision histories, and additional materials are also defined for inclusion across all document types.

Uploaded by

Ma. Sheila Magboo
Copyright
© © All Rights Reserved
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/ 6

DOCUMENT TEMPLATES FOR

SOFTWARE ENGINEERING PROJECTS

1.0 Overview of the Documentation Set


The following table identifies the minimal core set of software, and identifies the activities that produce
them.

Document Deliverables Description Activities (IEEE/EIA 12207.2-


1997) [10]
Software Project Management Description of the software System requirement analysis
Plan (SPMP) approach and associated Software requirement analysis
milestones.

Software Requirements Description of the expected Process implementation


Specifications (SRS) software features, constraints,
interfaces and other attributes
Software Design Description Description of how the software System architectural design
(SDD) will meet the requirements. Software architectural design
Also describes the rationale for Software detailed design
design decisions taken
Software Test Documentation Description of the plan and Software qualification testing
(STD) specifications to verify and System qualification testing
validate the software and the
results.

IEEE terms and abbreviations have been used throughout; this provides exposure to the professional
terminology for students, and also reduces ambiguity.

2.0 Purpose of each document


Document Summary of Purpose
SPMP To document the agreed deliverables and dates.
SRS To document the agreed requirements with the project supervisor/client; to
provide the basis for design; to provide the basis for system test.
SDD To document the design and design decisions in order to provide the basis for
implementation and unit test
STD To document how the software will be tested, and record the results
3.0 Common Sections for the Documentation Set
Each document within the recommended set has some common characteristics. The following pages are
included in each document:

I. Cover page (contents & layout)

Name of Document

Project Title

Document Version Number

Printing Date

Location of electronic version of file

Department & University

II. Revisions page (contents)


i. Overview
ii. Target Audience
iii. Project Team Members
iv. Version Control History:

Version Primary Author(s) Description of Date Completed


Version Draft / final

Draft/Final
v. Signatures of Approval

III. Additional Material (contents)


i. ADDITIONAL ISSUES
ii. DFINITIONS, ACRONYMS, AND ABBREVIATIONS
iii. REFERENCES
iv. APPENDICES
4.0 Contents of the Documentation Set

The following four pages identify the contents of each document. A detailed description of the contents
will be provided in a future Technical Report. The contents are not a rigid definition, but a guide as to
the most pertinent features of each document. These should be tailored to reflect the emphasis of each
project. Documentation produced during implementation is not covered; these results are usually in the
form of executable code, user documentation, and an implementation journal/engineering notebook
recording the implementation work of the student. The specifications for, and results of, unit testing are
also regarded as being part of the implementation.

Software Project Management Plan (SPMP)

Cover Page
Revisions Page
Table of Contents

1. INTRODUCTION
a. Project Overview
b. Project Deliverables
2. PROJECT ORGANIZATION
a. Software Process Model
b. Roles and Responsibilities
c. Tools and Techniques
3. PROJECT MANAGEMENT PLAN
a. Tasks
i. Task-n
ii. Description
iii. Deliverables and Milestones
iv. Resources Needed
v. Dependencies and Constraints
vi. Risks and Contingencies
b. Assignments
c. Timetable
4. ADDITIONAL MATERIAL
Software Requirements Specifications (SRS)

Cover Page
Revisions Page
Table of Contents

1. INTRODUCTION
a. Product Overview
2. SPECIFIC REQUIREMENTS
a. External Interface Requirements
i. User Interfaces
ii. Hardware Interfaces
iii. Software Interfaces
iv. Communications Protocols
b. Software Product Features
c. Software System Attributes
i. Reliability
ii. Availability
iii. Security
iv. Maintainability
v. Portability
vi. Performance
d. Database Requirements
3. ADDITIONAL MATERIAL
Software Design Description (SDD)
Cover Page
Revisions Page
Table of Contents

1. INTRODUCTION
a. Design Overview
b. Requirements Traceability Matrix
2. SYSTEM ARCHITECTURAL DESIGN
a. Chosen System Architecture
b. Discussion of Alternative Designs
c. System Interface Description
3. DETAILED DESCRIPTION OF COMPONENTS
a. Component-n
4. USER INTERFACE DESIGN
a. Description of the User Interface
i. Screen Images
ii. Objects and Actions
5. ADDITIONAL MATERIAL
Software Test Documentation (STD)
Cover Page
Revisions Page
Table of Contents

1. INTRODUCTION
a. System Overview
b. Test Approach
2. TEST PLAN
a. Features to be Tested
b. Features not to be Tested
c. Testing Tools and Environment
3. TEST CASES
a. Case-n
i. Purpose
ii. Inputs
iii. Expected Outputs & Pass/Fail criteria
iv. Test Procedure
4. ADDITIONAL MATERIAL (including appendix A)

APPENDIX A. TEST LOGS


A. Log for test n
a. Test Results
b. Incident Report

You might also like