Guidelines for the report of the software engineering course

Structure of Final Report The following format is recommended for the final report, which provides a comprehensive overview of the project's progress and outcomes.. Only specific chapter

VIETNAM NATIONAL UNIVERSITY OF HOCHIMINH CITY

THE INTERNATIONAL UNIVERSITY

SCHOOL OF COMPUTER SCIENCE AND ENGINEERING

GUIDELINES FOR THE REPORT OF THE SOFTWARE ENGINEERING COURSE

Ho Chi Minh City, 2024

This guide has been prepared to help students prepare their final report for theSoftware Engineering course The regulations contained within have beenupdated and, in some cases, clarified for the benefit of students, faculty advisors,schools, and the university.

1 The course project

 The course project is an academic exercise requiring students tocollaborate in groups These groups are expected to independentlydevelop research questions and conduct their research projects, leveragingknowledge gained from the course

 Group formation will occur during the course's first session Each groupwill consist of 3 to 10 members, and its size will be determined based onclass characteristics and total enrollment

 Groups are encouraged to propose their topics supported by crediblereferences

 Groups are strictly prohibited from copying reports from other groups

 Groups within the same class must work on different topics

 The project has three milestones, and teams must submit full requirementsfor each milestone: milestone 1: proposal, milestone 2: mid-term report,and milestone 3: final report and presentation The milestones' timing willdepend on that school year's academic calendar

2 Requirement and format for the final report 2.1 Structure of Final Report

The following format is recommended for the final report, which provides a comprehensive overview of the project's progress and outcomes Please NOTE THAT a more concise format for proposal and midterm reports may be used, focusing on the reporting process Only specific chapters, such as Chapter 1: Introduction and Chapter 2: Timeline and In-Charge Table, may be required in such cases

Acknowledgments:

The acknowledgments section briefly acknowledges the individuals or organizations contributing to the project It recognizes mentors, colleagues, or other relevant parties' support, guidance, or assistance.

Table of Contents:

The table of contents provides an organized list of the report's chapters, sections,subsections, and corresponding page numbers It helps readers navigate the report and locate specific information quickly

List of Figures:

The list of figures includes the captions and page numbers of all the figures or illustrations used in the report It helps readers easily find and reference visual elements within the document

Chapter 1: Introduction:

The introduction chapter provides an overview of the project It introduces the background and context of the research, identifies the problem statement or research question, outlines the scope and objectives of the project, and presents the customer requirements or motivations behind the project The chapter also provides an overview of the report's structure, giving readers an outline of what

to expect in the subsequent chapters

Chapter 2: Project Timeline and In-Charge Table

This chapter combines the project timeline and the in-charge table to provide a comprehensive overview of the project's development and the individuals responsible for specific tasks or areas It presents a chronological sequence of events, activities, and major milestones, along with the corresponding team members in charge of each task

Chapter 3: Methodology:

The methodology chapter explains the approach, methods, and techniques used

in the project It describes the overall methodology or framework adopted, including user requirement analysis, system design, database design, user interface design, and other relevant methodologies The chapter may provide an overview of each method and its application to the project

Chapter 4: Implementation and Results:

The implementation and results chapter describes the project's implementation and presents the outcomes or results achieved It details the implementation process, including any software or hardware used, algorithms or models developed, and any challenges encountered during implementation The chapter also presents the results, such as data analysis, experimental findings, or system performance metrics

Chapter 5: Discussion and Evaluation:

The discussion and evaluation chapter interprets and analyzes the results obtained in the previous chapter It discusses the significance and implications

of the findings, compares them with existing literature or similar projects, and may explain unexpected results The chapter evaluates the project's

effectiveness, limitations, and potential improvements and may include suggestions for future work

Chapter 6: Conclusion and Future Work:

The conclusion and future work chapter summarizes the essential findings and conclusions of the project It restates the objectives and highlights the project's contributions or impact The chapter also discusses potential future directions or areas for further research, suggesting ways to build upon the project's outcomes

References:

The references section lists all the sources cited in the report, following a specific citation style such as APA or MLA It provides readers with the necessary information to locate and verify the referenced works

Appendix:

The appendix includes any supplementary material or additional informationthat supports the main content of the report This may include detailed technical

specifications, code snippets, survey questionnaires, raw data, or any otherrelevant information not included in the main body of the report.

2.2 Format

The student is responsible for ensuring that the report is submitted in the properformat The highest standard of mechanical details must be achieved Thestudent is responsible for the form of the report and should carefully edit thefinal draft for arrangement, sentence structure, paragraphing, punctuation,spelling, quotations, tables, and bibliography with the aide of the committee The report should be prepared in a format acceptable to your school andcommittee However, the International University requirements must be

followed

The maximum length:

- Proposal: 1 – 3 pages

- Mid-term report: 4 – 8 pages

- The final report should be a comprehensive document of at least 30 pages,comprising only the main text and excluding endnotes, appendices, and the list

of references While there is no strict upper limit, aiming for a final reportranging from 30 to 50 pages is advisable However, please note that theevaluation of the final report will primarily focus on its quality rather than itslength Order of Material Title Page, Table of Contents, List of Tables,Figures, Each Chapter, List of References, Appendix, Index (optional)

Numbering of Pages Page numbers must be centered two lines below the

bottom margin There are no headings to the left or right of the page number.See margins above The placement of page numbers must be consistentthroughout the manuscript Pages should be numbered sequentially throughoutthe manuscript Preliminary pages are numbered as follows:

 The title page is counted as page i (assumed, do not print number)

 The remaining preliminary pages are numbered with lowercase Romannumerals (ii, iii, iv, etc) After the title page, please begin numbering thenext page with iv

 The main body of the text and the reference section are consecutively.Numbered with Arabic numerals beginning page “1” and continuing throughout,including text, illustrative materials, list of references, and appendices

Font Selection Font sizes should be selected carefully and enhance the

publication's professional quality Times New Roman 12 point is recommended

To make this adjustment, set your bottom margin at 0.800

The use of "justified" or "ragged-right" margins are acceptable but are notinterchangeable

Spacing Documents should be double-spaced throughout, except for the table of

contents, bibliography, and quotations of more than four lines or two or moresentences

Paragraph Indentions : Either a block with 4 spaces separated or indented 3/4"

is acceptable It would be best if you were consistent

Title Page

1 Name of the International University and the school

2 Title of the Course and Course ID

3 Topic’s Name

4 Group Information (Name, Student ID, Leader/ Member)

5 Lecturer’s Name

Table of Contents/List of Tables and Illustrations Follow the format of the

abbreviated sample included in these instructions This page is to be fullyjustified Any titles with more than one line should be single-spaced If a secondpage is required, include the appropriate heading, such as “Table of ContentsContinued”

Headings of Major Divisions The first line of the first chapter will be

"CHAPTER 1" Three lines below this appears the title of the chapter in capitalletters, centered Use an inverted pyramid and double-space the succeeding lines

of the title if it is longer than one line Three lines below the chapter title, placethe first line of text Succeeding chapters, "CHAPTER 2", etc., should followthis same format Do not use terminal punctuation on any chapter headings

Headings of Subdivisions Any logical system of subdivision within chapters or

sections is permissible, but the scheme must be consistent throughout themanuscript The subdivision within a chapter or section does not begin on a newpage unless the preceding page is filled If there is not room for the completeheading and at least two lines of text at the bottom of a page, the newsubdivision should begin on the next page

References References usually consist of information in parenthesis or square

brackets within the text Two common methods of referencing are (1) to useauthor's name and date of publication, as in (Smith, 1990), or (2) to assignnumbers to the bibliographical entries and insert the corresponding number forthe authors as they are cited in the text, as in Smith (95) The purpose ofreferences is to guide the reader to the corresponding entry in the List ofReferences or Bibliography, where complete information is available

Appendix An appendix is not required; however, if desired, you must maintain

the same margins and consecutive page numbering as used in the body of thetext

Photographic Reproductions/ Scanned Images New technology continues to

provide methods for displaying photographs and images in your final report.You are responsible for ensuring that the highest resolution quality is presented

in your final report

Tables and Figures Tables and figures are to be incorporated in the text as

appropriate and not included as a set at the end of the chapter or final report.Tables, which normally take more than an 8 ½ x 11-inch sheet, must be dividedand typed on more than one sheet or typed and drawn on a larger sheet andreduced photographically All titles and page numbers must be in the same fontand type size as the body of the text The area used for the graph and all captionsand legends must be within the appropriate margins

Color The hard copies made from electronic submissions of the final report all

colors appear as shades of gray Identification of lines on a graph is better made

by line symbols than by variation in color Large areas of solid color (e.g.,countries on a map) will show better as cross-hatchings in black

(This is a sample of the title page)

VIETNAM NATIONAL UNIVERSITY OF HOCHIMINH CITY

THE INTERNATIONAL UNIVERSITY

SCHOOL OF COMPUTER SCIENCE AND ENGINEERING

SOFTWARE ENGINEERING

IT076IU

PROPOSAL/MID-TERM REPORT/FINAL REPORT

Topic: Topic Name

By Group 01 – Member List

Instructor: Assoc Prof Nguyen Thi Thuy Loan

It is with deep gratitude and appreciation that I acknowledge the professional guidance

of Assoc Prof Nguyen Thi Thuy Loan Her constant encouragement and support helped our team to achieve its goal

My gratitude goes to the other laboratory members, Mr Tran Van B and Mr Nguyen Thi C Their technical help and good humor made these years a great learning experience I am grateful to the faculty of the School of Computer Science of the International University, especially Dr Nguyen Van D, for his support since the beginning of my studies Gratitude is also expressed to the members of my reading and examination committee.

Note: Paper A4, Top: 2.5cm; Bottom: 2cm; Left: 3cm; Right: 2cm, lines: 1,5

(This is a sample of table of contents)

TABLE OF CONTENTS

ACKNOWLEDGMENTS 3

TABLE OF CONTENTS 4

LIST OF FIGURES 6

LIST OF TABLES 7

ABSTRACT 8

CHAPTER 1 9

INTRODUCTION 9

1.1 Background 9

1.2 Problem Statement 9

1.3 Scope and Objectives 9

1.4 Customer Requirements 9

1.5 Report structure 9

CHAPTER 2 10

PROJECT TIMELINE AND IN CHARGE TABLE 2.1 Project Timeline 2.2 In-Charge Table CHAPTER 3 11

METHODOLOGY 11

3.1 Overview 11

3.2 User requirement analysis 11

3.2.1 Sub 1 11

3.3 System Design 11

3.3.1 Datadase design 11

3.3.2 User Interface design 11

3.4 Other 11

CHAPTER 4 12

IMPLEMENT AND RESULTS 12

4.1 Implement 12

4.1.1 Abc 12

4.2 Results 12

4.2.1 Result 1 12

4.2.2 Result 2 12

CHAPTER 5 13

DISCUSSION AND EVALUATION 13

5.3 Evaluation 13

CHAPTER 6 14

CONCLUSION AND FUTURE WORK 14

6.1 Conclusion 14

6.2 Future work 14

REFERENCES 15

APPENDIX 16

(This is a sample of a list of figures The number of each figure is similar to the

number of each table For example, Figure 2.1 means that this is the first

figure in Chapter 2)

LIST OF FIGURES

Figure 1.1: Use case diagram………7

Figure 2.2: Entity Relationship Diagram desmonstration……….…16

Figure 3.1: Agile Process Structure……… ………24

Figure 4.1: System model architecture………… ……… ………35

Figure 5.1: Gantt chart……….……… ………40

(This is a sample of a list of tables The number of tables is based on their

appearance in each chapter)

This report presents a study on implementing and evaluating a novel algorithm for image recognition in autonomous vehicles The algorithm utilizes deep learning techniques to achieve high accuracy in real-time object detection The study addresses the challenges autonomous vehicles face in identifying and classifying objects in dynamic and complex environments Experimental results demonstrate the effectiveness and efficiency of the proposed algorithm, showcasing its potential for enhancing the safety and reliability of autonomous vehicles.