KUFA UNIVERSITY

Department ofComputer Science

21/04/23

Fundamentals of Software Engineering

Presented ByPresented ByNeamah HassanNeamah Hassan

Presented ByPresented ByNeamah HassanNeamah Hassan

21/04/23

s/w documentation s/w documentation

• s/w documentation s/w documentation • 1- good document help enhance understandability of S/W product 1- good document help enhance understandability of S/W product

and good documents help to reduce the effort and time required and good documents help to reduce the effort and time required for maintenance . for maintenance .

• 2- good document help the user to understands and effectively use 2- good document help the user to understands and effectively use the system the system

• 3- good document helps the manger to effectively track the 3- good document helps the manger to effectively track the progress of the project progress of the project

•

20/11/201220/11/2012

Type of Type of documentdocumentationation

Internal documentInternal documentationation

1-1- it is provided in the source code it self it is provided in the source code it self

2-2- prepared mainly for programmers prepared mainly for programmers

3-3- prepared in the form of comments , meaningful variable prepared in the form of comments , meaningful variable

name , etc . Within the code name , etc . Within the code

4-4- changes are made in internal document at first changes are made in internal document at first

5- 5- should follow programing conventions to be understood should follow programing conventions to be understood by other programmers. Such as using meaningful variable by other programmers. Such as using meaningful variable name is most useful while trying to understand the piece of name is most useful while trying to understand the piece of code and using the comments code and using the comments

6-6- ex- comment embedded in source code , meaningful variable name ex- comment embedded in source code , meaningful variable name

21/04/23

Type of Type of documentationdocumentation

External External documentationdocumentation

1-1- it is provided through in supporting documents that it is provided through in supporting documents that accompany S/W product accompany S/W product

2-2- prepared mainly for user prepared mainly for user

3-3- prepared in the form of textual data prepared in the form of textual data

4-4- the change are reflected in external document and any the change are reflected in external document and any change in the code should be reflected in external doc change in the code should be reflected in external doc

5- 5- should follow simple language to be understand by end should follow simple language to be understand by end user user

6-6- ex- user manual , SRS , ex- user manual , SRS ,

21/04/23

21/04/23