Software Documentation

Hans-Petter Halvorsen

1 2 3

Schedule Week Assignment Textbooks Quiz Q&A Previous Next 

×

Software Documentation - This week's highlights

 

This weeks topic is Software Documentation. We will continue working with Documentation [Sommerville, Web Chapter] needed in a software project. 

 

For more details, see the Week Assignment.

1. Preparations

2-3h. Main focus: Prepare to participate in class activities. It is important that you are prepared when you come to class. 

Software Documentation - This week's highlights

 

Software

You need the following Software (make sure to install them before you come to class!):

 

Resources

Please go through the resources below before you meet in class.

Documents:

Read Documentation [Sommerville, Web Chapter] needed in a software project. 

Document Checklist - It is good idea to make (or use) a “Document Checklist” to make sure that you don’t deliver documents with basic and obvious mistakes. Use it as a basic Quality Control before you send the document to others (Its almost like Unit Testing but for the different items inside a document instead of your source code).

 

Textbooks

The theory part of this course is "reading material" (it's like reading a novel), so be sure to take a look at some of the textbook resources below, and especially the Sommerville book (or Safari books online book if you dont have the Sommerville book). The main concept in this course is to read the theory at home and they apply the theory concepts on the project.

Software Development Literature

 

Read the following chapters in one ore more of the following Textbooks below before you meet in class:

Textbook Syllabus
Software Development - A Practical Approach
  • Ch. 15 Project Documentation
Software Engineering (I. Sommerville)
Essentials of Software Engineering (Frank Tsu et al.)
  • App. A - D (SDP, SRS, SDD, STP)
Software Engineering (Saikat Dutt, et al.)  

2. Activities in Class

6h. Main focus: Practice applying key concepts with feedback. Execution and review of the week assignment will be the main focus in class on Tuesdays and Fridays.

 

Review: Review of reported Bugs/Features in Azure DevOps, and Unit Tests created in Visual Studio. Delivery: Fill out and deliver the Forms given in class:

 

Week Assignment

It is important that you do what's in the weekly assignments. The weekly assignments guides you through the course with a red line with a primary focus on important topics in software engineering and practical implementation of these topics through a large project. The contents of the week assignments are important criteria when it comes to censorship and grading in this course. 

 

Team Assignment: This week we will focus on creating System Documentation and a User Manual for our system.

The User Manual(s) should be created as one or more Videos. Everybody should participate, either create one video each or create different parts of one Video.

Deadline (1.draft): Next Tuesday 10:15. Video(s): Should be available from the Teams HTML Web Site. System documentation: Should be available from the Teams HTML Web Site + original document should be located in Teams.

 

Quiz:

Friday Afternoon Quiz - Can you relax this weekend? - or do you need to take an extra look at some of the available resources? In order to Pass this Quiz, you need to get a Score >= 70%. You should answer the questions without any aids!

 

3. Complementary Work

6-7h. Main focus: Finish Week Assignment. Check your understanding and extend your learning. Go through the following resources in order to review and get a deeper understanding of what you should learn in this topic. You may also need these resources in order to solve the week assignment.

 

No Additional Resources for this Topic.

 

Review

Review Questions - Note! This is mandatory! In order to Pass this Quiz, you need to get a Score >= 50%.

In order to get best outcome, you should answer the questions without any aids! You should also write your answers in your own words using Norwegian language. Don't just copy the text directly from the PowerPoints or the Textbooks, in that way you dont learn anything! When answering the Questions, pretend you are sit down taking the final written Exam. This means you should watch Videos, read the Textbooks, PowerPoints and oher Resources in advance before you start answering the Review Questions.

Questions and Answers (Q&A)

In this Forum everybody can ask Questions, answer Questions, give Tips and Tricks, etc. regarding Software Development. Please use Full Name and Picture.