KUFA UNIVERSITY

1. KUFA UNIVERSITY Department of Computer Science

2. Fundamentals of Software Engineering Presented By Neamah Hassan

3. s/w documentation • s/w documentation • 1- good document help enhance understandability of S/W product and good documents help to reduce the effort and time required for maintenance . • 2- good document help the user to understands and effectively use the system • 3- good document helps the manger to effectively track the progress of the project

4. Type of documentation Internal documentation 1- it is provided in the source code it self 2- prepared mainly for programmers 3- prepared in the form of comments , meaningful variable name , etc . Within the code 4- changes are made in internal document at first 5- should follow programing conventions to be understood by other programmers. Such as using meaningful variable name is most useful while trying to understand the piece of code and using the comments 6- ex- comment embedded in source code , meaningful variable name

5. Type of documentation External documentation 1- it is provided through in supporting documents that accompany S/W product 2- prepared mainly for user 3- prepared in the form of textual data 4- the change are reflected in external document and any change in the code should be reflected in external doc 5- should follow simple language to be understand by end user 6- ex- user manual , SRS ,