You are on page 1of 14

Asia Pacific University of Technology and Innovation

INVES
TIGATI
ON
REPOR
T (IR)
GUIDE
LINES
SCHOOL OF COMPUTING (SOC) & SCHOOL OF TECHNOLOGY (SOT)
2023

1
V1-AUGUST2023
Asia Pacific University of Technology and Innovation

IR REPORT WRITING GUIDELINES (SOC & SOT)

COVER PAGE
Please follow the correct format for the cover page that has been prepared. You may find it in
the designated folder that has been prepared by your respective FYP managers.
Important note:
 If you are doing a dual degree program, kindly ensure you include the DMU
logo on the cover page. Otherwise, it will be affecting your mark.
 DMU logo is on the left side, and APU Logo is on the right side.
 If the DMU Logo is not needed, ensure the APU Logo remains on the right
side.

ACKNOWLEDGEMENT PAGE
This section is written in one page to acknowledge gratitude to contributing persons/parties.

Figure 1: Acknowledgement Sample


ABSTRACT PAGE
An abstract section is a one-paragraph summary of a research project. An abstract may
contain the following information:
 The purpose of the project identifying the area of study to which it belongs.
 The research problem that motivates the project.
 The methods used to address this research problem, document, or evidence
analyzed.
 The conclusion reached or, if the research is in progress, what the preliminary
result of the investigation suggests.
2
V1-AUGUST2023
Asia Pacific University of Technology and Innovation

 The significance of the project.


 What are the mapping SDG components that can be related to the project?
Explain briefly.
 Maximum 6 keywords to be included at the bottom of the abstract.
 Note that the word limit is 200 words.

Figure 1: Abstract Sample

TABLE OF CONTENTS
Students may refer to the whole structure written in this guideline to arrange the table of
contents.

LIST OF FIGURES
Figures include diagrams, photographs, screenshots, graphs, charts, code snippets, etc.
Includes the title of all figures and the page number where the figure can be found in the text.

LIST OF TABLES
Includes the title of all tables and the page number where the table can be found in the text.

Important notes:
Cover page, Acknowledgment page, Abstract page, Table of Contents page, List of Figures
page, and List of Table page – each of them must be started on a new fresh page.

3
V1-AUGUST2023
Asia Pacific University of Technology and Innovation

MAIN CHAPTERS

CHAPTER 1: INTRODUCTION

Chapter 1 of the report is important since it describes the overall project and its outcome. As
this is the first chapter that the evaluators will read, it is essential to make a good first
impression. It is important to write a chapter that clearly explains the project’s flow. A
thorough understanding of the groundwork is necessary to write a well-written chapter. Table
1 shows the outline of Chapter 1.

CHAPTER 1 INTRODUCTION

1.1 Introduction
 Assume that readers have little knowledge about your project
topic/domain/field.
 Relate your project introduction to the selected SDG goal.

1.2 Problem Background


 Example: Explain why current technology T is underperforming environment Z.
 Relate your project problems to the selected SDG goal.

1.3 Project Aim


 A single sentence/statement.
 Explaining the key target of the project.
 Example: To develop a system X using technology Y to be employed in
environment Z.

1.4 Objectives
 A minimum of three objectives and a maximum of four.
 Must be measurable
 Start your objective with ‘To…’
 Construct between 3 – 4 objectives only.

1.5 Scope
 Describe in detail the tasks to be executed.
 Constraints regarding any part of the project development (e.g., size of system
and technology).
 What will and will not be done as part of the project?

4
V1-AUGUST2023
Asia Pacific University of Technology and Innovation

1.6 Potential Benefits


 Tangible benefits
 Intangible benefits
 Target user

1.7 Overview of the IR


Describe the structure of your IR report

1.8 Project Plan


Include all project tasks and sub-tasks for FYP Semester 1.

Table 1: Outline of Chapter 1

Project plan sample:

5
V1-AUGUST2023
Asia Pacific University of Technology and Innovation

CHAPTER 2: LITERATURE REVIEW

In Chapter 2, all the results and findings of the review of the literature are presented. The
literature review provides a sound basis for a good problem formulation and planning of the
project. From the literature review, students will be able to build a basic understanding of the
project. Table 2.1 shows the outline of Chapter 2 of the report.

CHAPTER 2 LITERATURE REVIEW

2.1 Introduction
Describe the chapter introduction such as what contents you will cover/discuss in this
chapter.

2.2. Domain Research


 Study of the domain from general to specific.
 Study of Related theories/technology/algorithms that can contribute towards
solving the problems and others.
 Every sub-topic within the domain must have a review
 Ensure you review and discuss in detail how your project domain can achieve the
selected SDG goal.

2.3 Similar Systems/ Works


 Characteristics of similar systems/ works
 Strength and weakness
 Review and discuss in detail are these similar systems/works were able to achieve
the selected SDG goal.
 Conclusion

2.4 Technical Research


Describe technical requirement analysis:
2.4.1. Identify the hardware/software for the project and justify
2.4.2. IDE (Interactive Development Environment) chosen – (this section is optional)
2.4.3. Libraries chosen / Tools chosen – (this section is optional)
2.4.4. Database Management System chosen – (this section is optional)
2.4.5. Operating System chosen
2.4.6. Web Server chosen – (this section is optional)
2.4.7. Web browser chosen – (this section is optional)

6
V1-AUGUST2023
Asia Pacific University of Technology and Innovation

2.5 Summary
Describe the chapter summary such as what you have discussed in this chapter, etc.

Table 2: Outline of Chapter 2


CHAPTER 3: METHODOLOGY

The methodology describes the overall approach and framework chosen for research and
system development. The content for the methodology chapter of the report can hold
methods, techniques, or approach that is used or will be used during the design and
implementation of the project.
In addition, this chapter also justifies the choice of methods or approaches, as well as
hardware and software requirements. It must be noted that the primary objective is not to
explain the functions of each phase but rather the process that goes on within. Table 3.1
shows the outline of Chapter 3 of the report. This outline must be followed, although slight
modifications that enhance understanding of the project are accepted.

For CS and CSAI students:


CHAPTER 3 METHODOLOGY

3.1 Introduction
Describe the chapter introduction such as what contents you will cover/discuss in this
chapter.

3.2 System Development Methodology


3.2.1 Introduction of methodology
3.2.2 Methodology choice and justification
3.2.3 Describe the activities and process in each phase toward the chosen
methodology (traditional or modern) in detail.
Notes:
 methodologies for system development such as RUP, Waterfall, V-Model,
Extreme Programming, etc.
 CS and CSAI students who are developing a system with data analytics features
may combine a methodology for system development with a methodology for Data
Analytics. Ensure you discuss this with your supervisor.

3.3 Data Gathering Design


Describe the data gathering techniques choose for the project, choose either one:
o Surveys
o Interview

7
V1-AUGUST2023
Asia Pacific University of Technology and Innovation

o Document analysis
o Observation
o Other relevant techniques
 Design the questions/event /activities based on the selected data-gathering
technique and get verification from the supervisor, through the ethic forms.
 Minimum number or participant to be used:
o Survey = 30 participants
o Interview = 3 participants
 Note that this data gathering activities need to be conducted with the identified
target audience and not with your friends.
 Data gathering aimed to help you identify system requirements, or to collect any
data/information related to your project. Including potential system functionalities,
potential upgrades/enhancements that the end users wishes to see in the new
system.
 Note that respondent demographic information is needed to be included in the
appendix

3.4 Analysis
 Analysis results towards the data retrieved from the data gathering activities.
 Final list of user requirement summarized from the analysis.

3.5 Summary
Describe the chapter summary such as what you have discussed in this chapter, etc.

Table 3: Outline of Chapter 3 for CS and CSAI student

For CSDA students:


CSDA students are not mandatory to conduct surveys or interviews. However, CSDA
students are required to perform data collection (may use open dataset sourced from Kaggle,
etc), data understanding, and data pre-processing.
CHAPTER 3 METHODOLOGY

3.1 Introduction
Describe the chapter introduction such as what contents you will cover/discuss in this
chapter.

3.2 Methodology
3.2.1 Introduction of methodology
3.2.2. Methodology choice and justifications.
3.2.3 Describe the phases, activities, techniques, and processes in each phase

8
V1-AUGUST2023
Asia Pacific University of Technology and Innovation

Towards the chosen Methodology.


Note: methodology selection for data analysis such as CRISP-DM, KDD,
Or SEMMA

3.3 Data Collection


 Data Collection – identify your dataset explain the source of your dataset and
provide the dataset source link.

3.4 Initial Data Pre-processing and Data Understanding


3.4.1 Data Pre-processing
Perform all data pre-processing steps for your dataset with any preferred tools
(such as Jupyter, Google Colab, etc).
 Missing Values
 Outliers
 Data Transformation
 Data Standardization
 Data Normalization
 Etc – add any other necessary sections for your ‘data pre-processing’ phase.

3.4.2 Data Understanding


Perform all data understanding steps for your dataset with any preferred tools
(such as Jupyter, Google Colab, etc)
 Variables – explain variables in your dataset
 Observations – explain observations in your dataset
 Histogram – create histograms or any other visualizations to understand
further your dataset.
 Etc – add any other necessary sections for your ‘data understanding’ phase.

3.5 Summary
Describe the chapter summary such as what you have discussed in this chapter, etc.

Table 3a: Outline of Chapter 3 (for CSDA students)

CHAPTER 4: CONCLUSION

This chapter focuses on the concluding remarks of the first part of the Project.

CHAPTER 4 CONCLUSION

4.1 Discuss the achievement of the first part of the project

9
V1-AUGUST2023
Asia Pacific University of Technology and Innovation

4.2 Justify were the student able to do enough investigation/ research concerning what to
achieve for the project. Ensure relate your investigations results with the selected SDG
goal.
4.3 Justify if there are any gaps in the research and design areas that the student may want
to further explore and improve.
Table 4: Outline of Chapter 4
REFERENCES

References are a detailed description of items from which information was obtained in
preparing the project report. Every data, information, quotation, figure, table, or anything
taken from another source must be cited in the report. Citation must be done within the report
and also in the reference list at the end of the report. References shall come from sources such
as journals, articles, and books. References from the internet (i.e., citations from websites) are
not encouraged. Students must you the APA style for the references (refer to Figure 1).

10
V1-AUGUST2023
Asia Pacific University of Technology and Innovation

Figure 1: References Sample

APPENDICES

Appendices provide supporting materials that will strengthen the explanation and review of
the project. Following is the appendices’ structure that must be followed.:

 Appendix A: PPF
o Students need to include the screenshots of PPF (all pages) submitted earlier
during the title registration inside the report.

Figure 2: PPF Sample

 Appendix B: Ethics Forms (Fast Track / Full Track)


o Students need to include screenshots of the ethics form (all pages) submitted
earlier in Moodle for the use of acquiring approval for the data-gathering
design that needs to be included in the report.

11
V1-AUGUST2023
Asia Pacific University of Technology and Innovation

Figure 3: Ethics Form – Fast Track Sample


 Appendix C: Log Sheets (3 log sheets)
o Students need to include screenshots of the 3 meeting log sheets.
o These log sheets need to be used by the student to document the meeting with
the supervisor on regards of the project's progress.
o It is the responsibility of the student that this logbook is kept up to date and
that the student complies with the Supervisor’s suggestions and
recommendations as noted by the student in the logbook and approved be
signed by the Supervisor.
o Students MUST make a regular meeting with a supervisor with a minimum
number of meetings are 3 meetings per semester.
o This logbook has to be submitted together with the report as well as uploaded
in the required link inside Moodle. Below are the examples of the project log
sheet.

12
V1-AUGUST2023
Asia Pacific University of Technology and Innovation

Figure 4: Project Log Sheet Sample

 Appendix D: Gantt Chart


o Students should include the timeline of the semester in completing Project Part
1 (IR).

Figure 5: Gantt Chart Sample

13
V1-AUGUST2023
Asia Pacific University of Technology and Innovation

 Appendix E: Respondent Demographic Profile


o This section provides information about the respondents (participants) who
participate in the data collection process/survey or interview.
o Note: This section is optional for CSDA students as CSDA students are not
mandatory to conduct survey/interview.

Participant Gender Age Occupation


Joanne Female 30 - 45 Admin
Simon Male 25 - 30 Unemployed
John Male 30 - 45 IT Executive
Jacqueline Female 45 - 54 Programmer
Maria Female 30 - 45 Housewife
etc
etc
Note: the name of the participant can be a pseudonym and not the actual name to protect the
confidentiality

Table 5: Respondents Demographic Profile Example

14
V1-AUGUST2023

You might also like