Reports from the IDEA2 Developers' Teams

(LeongHW; Date: 12-Nov 1:30am)

Each of the IDEA2 Developers' Teams will need to submit a report on their project work. For bigger teams, the Team Lead will coordinate the writing of this report. For small teams (with 2 persons), I will leave it to the team.

Below, I give the rough outline of the report for your reference. For each section, I give some comments to help you know what you are supposed to write there. This is a guideline, you can choose to modify it as appropriate. Please also let me know if you feel you have a better organization for the details that is needed. (Please also use last semester's reports as a reference. Follow the good ones, don't repeat the mistakes of the bad ones.)

IMPORTANT MESSAGE:
Please taken note that these reports are also crucial for future UIT2201 students who will continue to enhance this intelligent door. So write your reports assuming that your reader is someone who needs to maintain your code -- give enough details about assumptions, about compilers, about settings, and so on -- so that the next person will be "maintain" the software properly.

(GUI) IDEA2 GUI Team Report

1. Introduction

{Authors of the report, Purpose of this report, scope of the report, target audience of this report}

2. The Overall System Architecture of IDEA2 GUI

{Brief description of the system architecture of IDEA2 GUI (adapt and modify from the overall architecture given by Prof Leong). Also some description of how GUI sub-components fit together -- and give some examples.

If appropriate, describe the old and the new -- and what changes are made to the overall architecture of the GUI.

3. IDEA2 Requirements Specification

{Description of the (high level) requirements specification for IDEA2. Also description of how these are broken down and what are the data fields that needs to be captured. This can be adapted from the documents provided given by Prof Leong.}

4. Design of IDEA2 GUI Sub-System

{Overview of the design of the GUI sub-system. IDEA2 GUI made up of frames, what are the various parts of the GUI, how they interact and so on. Any complicated issue to taken -- what solutions were taken. Then the decomposition of the IDEA2 GUI codes (perhaps functional decomposition).

If appropriate, describe the old and the new -- and what changes are made to the design of the GUI (from IDEA to IDEA2).

5. Implementation of IDEA2 GUI Sub-System

{Overview of the implementation of the IDEA2 GUI sub-system. The language chosen, and pertinent information (imagine the reader is someone who is maintaining your code and making changes to it.)

Where appropriate, describe the old and the new -- and what changes are made to the implementation details or coding styles of the GUI. Also, what was working, what was corrected (either implemented but not integrated, or was not working), what was newly implemented.

6. Testing of the IDEA2 GUI

{Step needed to "install" the IDEA2 GUI (if any). How the IDEA2 GUI is tested and include testing-code/test-data or testing-sequences used.}

7. Summary and Conclusion

{Contribution of your team, Division of Labour (how the job was divided up and who did what in the team), what you have learnt from the project, and what possible future enhancement to make it better.}

Appendix: Documents, Codes, etc

{This appendix is for you to print out the full documents, program code, test data, test programs, etc created by your team.}

(DBD) IDEA2 Database Design and Implementation Team Report

1. Introduction

{Authors of the report, Purpose of this report, scope of the report, target audience of this report}

2. IDEA2 Requirements Specification

{Description of the (high level) requirements specification for IDEA2. Also description of how these are broken down and what are the data fields that needs to be captured. } In this description, please emphasize the new requirements specification -- this can be extracted from documents provided by Prof Leong.

3. IDEA2 Database Design

{Overview of the database design -- perhaps the ER diagram or some other form of describing the database schema. For each table, you should also specify the primary key and secondary key, if any. Please also state any assumption about the tables, attributes, data.}

Where appropriate, describe the old and the new -- and what changes are made to the design of the IDEA2 Database. (What's new and what's modified.)

4. Implementation of the IDEA2 Database

{Overview of the Implementation plan. The database chosen (Oracle) and the program (commands used to create the tables). (Imagine the person reading this report needs to do maintenance of the database.) }

5. Data Creation and Data Entry for IDEA2 Database

{Overview of how data was created and entered into the IDEA2 database. Are these via forms or via command-line interface or were special programs used. Also give a status of the size (number of records) in the various tables. (Again, give old and new figures.)}

6. Testing of the IDEA2 Database

{Step used in testing the database. How testing was done and what was tested.}

7. Summary and Conclusion

{Contribution of your team, Division of Labour (how the job was divided up and who did what in the team), what you have learnt from the project, and what possible future enhancement to make it better.}

Appendix: Documents, Codes, etc

{This appendix is for you to print out the full documents, program code, test data, test programs, etc created by your team.}

(DBMS) IDEA2 Database Management System Team Report

1. Introduction

{Authors of the report, Purpose of this report, scope of the report, target audience of this report}

Note that the DBMS is an offline system used to manage and maintain IDEA2 database created by the DBD team.

2. IDEA2 DBMS Requirements Specification

{Description of the (high level) requirements specification for DBMS for IDEA2. Namely, what the DBMS is required to do. (This can be modified from documents provided by Prof Leong.)}

3. IDEA2 DBMS Design

{Overview of how the system was designed and the resulting design of the system.}

4. Implementation of the IDEA2 DBMS

{Overview of the Implementation plan. How the DBMS was implemented, what software/programming languages was used.}

5. Testing of the IDEA2 DBMS

{Step used in testing the system built. How testing was done, the test data or test cases used, and what were tested.}

6. Summary and Conclusion

{Contribution of your team, Division of Labour (how the job was divided up and who did what in the team), what you have learnt from the project, and what possible future enhancement to make it better.}

Appendix: Documents, Codes, etc

{This appendix is for you to print out the full documents, program code, test data, test programs, etc created by your team.}

(Feature Teams) IDEA2 Feature Implementation Report (Team x) x=1,2,3

1. Introduction

{Authors of the report, Purpose of this report, scope of the report, target audience of this report}

2. IDEA2 Requirements Assigned to Team

{Description of the IDEA2 requirements (functions) assigned to the team. Given informal (English) description of each function and its purpose.

Where appropriate, please specify existing vs new requirements. Emphasize new requirements, but mention existing ones.

3. IDEA2 Function Implementation and Testing

{Overview of the Implementation plan, if appropriate.

Then, for each IDEA2 function,

4. Summary and Conclusion

{Contribution of your team, Division of Labour (how the job was divided up and who did what in the team), what you have learnt from the project, and what possible future enhancement to make it better.}

Appendix: Documents, Codes, etc

{This appendix is for you to print out the full documents, program code, test data, test programs, etc created by your team.}

(User Manual) IDEA User Manual Team Report

1. Introduction

{Authors of the report, Purpose of this report, scope of the report, target audience of this report}

{Note: You should be writing the User Manual for IDEA (the existing version -- since IDEA2 is still not ready yet).

2. The Overall Design Process for IDEA2 User Manual

{Brief description of the process taken to come up with the User Manual. What did the team do to get starts and how things were organized.

3. IDEA2 User Manual Design and Organization

{Describe how the user manual was organized into Chapters. Also description of how these chapters are broken down.}

4. Testing the Effectiveness of the User Manual

{Describe how you test the effectiveness of your user manual.}

5. Summary and Conclusion

{Contribution of your team, Division of Labour (how the job was divided up and who did what in the team), what you have learnt from the project, and what possible future enhancement to make it better.}

Appendix: Documents, Codes, etc

{This appendix is for you to print out the Full User Manual, and and other supporting documents created by your team in the project.}

(Training Manual) IDEA Training Manual Team Report

1. Introduction

{Authors of the report, Purpose of this report, scope of the report, target audience of this report}

{Note: You should be writing the Training Manual for IDEA (the existing version -- since IDEA2 is still not ready yet).

2. The Overall Design Process for IDEA2 Training Manual

{Brief description of the process taken to come up with the Training Manual. What did the team do to get starts and how things were organized.

3. IDEA2 Training Manual Design and Organization

{Describe how the training manual was organized into Sections. Also description of how these Sections are broken down. What mode of presentation was chosen and why.}

4. Testing the Effectiveness of the User Manual

{Describe how you test the effectiveness of your training manual.}

5. Summary and Conclusion

{Contribution of your team, Division of Labour (how the job was divided up and who did what in the team), what you have learnt from the project, and what possible future enhancement to make it better.}

Appendix: Documents, Codes, etc

{This appendix is for you to print out the Full Training Manual, and and other supporting documents created by your team in the project.}

(IHAS) Intelligent House Appliance Showcase Team Report (Team 1,2)

1. Introduction

{Authors of the report, Purpose of this report, scope of the report, target audience of this report}

2. IHAS Requirements Specification

{Description of the requirements for IDEA2 -- what IHAS is supposed to be.}

Also, the list of "intelligent appliance" to be shown. This can be adapted from the documents provided given by Prof Leong.}

3. Design of IHAS

{Overview of the design of your IHAS, your design ideas and how the "pieces" fit together in your IHAS. Also how you intend the look-and-feel of your IHAS.

4. Implementation of IHAS

{Overview of the implementation of your IHAS. The software and/or language chosen for this, and pertinent information (imagine the reader is someone who is maintaining your IHAS and making changes to it.)

4. Testing the Effectiveness of your IHAS

{How you conducted the testing of IHAS to make sure that it works. {Also, describe how you test the effectiveness of your IHAS.}

5. Summary and Conclusion

{Contribution of your team, Division of Labour (how the job was divided up and who did what in the team), what you have learnt from the project, and what possible future enhancement to make it better.}

Appendix: Documents, Codes, etc

{This appendix is for you to include any supporting documents, program code, etc created by your team in this project. Also, email the soft-copy of the IHAS over.}

UIT2201: CS & IT Revolution; (Fall 2003); A/P Leong HW