BITS C461/IS C341 Software Engiueering

First Semester 2003-04

Last Update: September 6, 2003

Back to Course Table of Contents

Project Documentation Guidelines
Title Page
Table of Contents
Table of Figures
Table of Tables
1 Introduction

1.1 Scope
1.2 Intended Audience
1.3 System Overview
2 Client Requirements Summary

2.1 Problem Domain
2.2 Functional Requirements
2.3 Constraints
2.4 System Usage
2.4.1 Operators / Actors
2.4.2 Operations / Use Cases
2.5 Known/Suggested Elements

3 Requirement Specification

3.1 System Functions
3.2 System Attributes
3.3 Use Case Decomposition
3.4 Test Plans
4 Design Specification

4.1 Design Guidelines / Goals / Principles
4.2 High-level Architecture
4.3 Handling of System Events
4.4 Application Framework
4.4.1 Class Responsibilities
4.4.2 Static Relations
4.5 Low-level Architecture
Appendix
Appendix A: Work Assignments
Appendix B: Problems / Resolutions
Appendix C: User Manual
Glossary