004_comission/ryankochun91735/task1/project/_doc_source/User Guide.md

Documents and final products in soft copies

Preliminary Study (original submitted version)

Initial Report (original submitted version)

Interim Report (original submitted version)

Final Report

Source code and applications (e.g. apk file)

Installation / Deployment Guide

User Guide

Presentation slides

Peer Review (per each member)

Critical Evaluation (per each member)

Hard-copy documents

---

Final Report

Cover

Please refer to cover template

Abstract

One or two paragraph(s) to show the objectives of the project and the final report.

Acknowledgement

Thank those who have helped in conducting the project

Table of Contents

You must use automatic tool to create this, e.g. “Table of Contents” in MS Word

Introduction

It should be exceed more than one page, including

1. Project title

2. General descriptions of the project objectives

3. General descriptions of the project results

4. Document structure with chapter titles

Project Background and Problem Analysis

1. Scope of the problem

2. Problem Statements and description

Proposed Solution

1. Scope of the proposed solution

2. Architecture of the proposed system and roles of hardwares

3. Advantages and drawbacks of the solution

Requirements

1. Roles of users

2. Functional Requirements

3. Non-functional Requirements: E.g. Reliability requirements, performance requirements, existing data interface and hardware environment, future extensions of the proposed solution, required implementation language.

Documentation for Problem Analysis

1. Use Case Diagrams They should map to your requirements in the previous chapters

2. Fully Dressed Use Cases

Documentation for Detailed Design

1. Database design (ERD) and metadata

• 

erd.md

1. System design (Data Flow Diagram, Class Diagram, etc.)

2. User interface design

   • 

Implementation

1. Test plans and results
2. Changes to design and justification of changes (if any)

Results and conclusions

1. Summary and critical discussion of the results

2. Limitations of the final products / solutions

• no access control at this stage.
• no pagination at this stage
  • if a lot of items it will congest in the same page.
• mail server setup for demo purpose.
• single language only

1. Problems/difficulties encountered

• need to familiar with the framework used (e.g. laravel orm...)
• feasibility study of the theme with framework used (e.g. laravel, scss..)
• need tryout docker concept

1. Delays/changes in project schedule

2. Suggestion of further improvements / development

• include more item.
• multilingual...

References

• docker documentation
• laravel 10.x documentation
• github/mailhog
• mysql documentation
• phpmyadmin documentation
• creativetim argon dashboard documentation

Appendices

User Guide