Reports from the IDEA Developers' Teams
(LeongHW; Date: 11-Apr 1:30am)
Each of the IDEA Developers' Teams (SDA1-3, FI-Team 1-4) will need to submit
a report on their project work.
For SDA2 and FI-Team 1-4, the Team Lead will coordinate the writing of this report.
For SDA1 and SDA2 (small teams), I leave it to you to coordinate between yourselves.
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 taken note that these reports are 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.)
(SDA1) IDEA Specification and High-Level Design 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 IDEA
{Brief description of the system architecture of IDEA given by Prof Leong}
3. Requirements Chosen for Implementation
{Overview of the (high level) requirements chosen for IDEA. Reason for the choice.
How these requirements are broken down into events and functions for the
FeatureImplementation Components. (Some examples)
4. Design of the IDEA Controller
{Overview of controller design,
how input is sent to your controller (IDEA.ini)
information required, syntax and semantics.
example of some events, and some functions, with detailed
explanation of the various parts of the .ini specification}
5. The Implementation of the IDEA Controller
{How the controller is implemented: language used, high-level pseudocode
and data structures/specialized methods used. References.}
6. Testing and Installation of the IDEA Controller Codes
{Step needed to install the controller, how testing is done
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.}
(SDA2) IDEA GUI Implementation 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 IDEA
{Brief description of the system architecture of IDEA given by Prof Leong.
Also some description of how GUI fits in -- events are selected from GUI (web
page), events trigger actions that produce results that are displayed by IDEA GUI.
Give some examples.
2. IDEA Requirements Specification
{Description of the (high level) requirements specification for IDEA.
Also description of how these are broken down and what are the data
fields that needs to be captured.
3. Design of IDEA GUI Sub-System
{Overview of the design of the GUI sub-system. IDEA 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 IDEA GUI codes (perhaps functional decomposition).
3. Implementation of IDEA GUI Sub-System
{Overview of the implementation of the IDEA GUI sub-system.
The language chosen, and pertinent information (imagine the reader
is someone who is maintaining your code and making changes to it.)
5. Testing of the IDEA GUI
{Step needed to "install" the IDEA GUI (if any). How the IDEA 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.}
(SDA3) IDEA Database Design and Implementation Report
1. Introduction
{Authors of the report,
Purpose of this report, scope of the report,
target audience of this report}
2. IDEA Requirements Specification
{Description of the (high level) requirements specification for IDEA.
Also description of how these are broken down and what are the data
fields that needs to be captured.
3. IDEA 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.}
4. Implementation of the IDEA 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.)
How data is added to the database (are there any forms/interface for
adding records to the database).}
5. Testing of the IDEA Database
{Step needed to install the controller, how testing is done
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.}
(FI Team) IDEA Feature Implementation Report (Team x)
1. Introduction
{Authors of the report,
Purpose of this report, scope of the report,
target audience of this report}
2. IDEA Requirements Assigned to Team
{Description of the IDEA requirements (functions) assigned to the team.
Given informal (English) description of each function and its purpose.
3. IDEA Function Implementation and Testing
{Overview of the Implementation plan, if appropriate.
Then, for each IDEA function,
- give a detailed specification in terms of input / output specification.
- give explanation of the input parameters and state preconditions assumed
on input.
- Give explanation for output produced.
- Give any data structures needed and pseudocode of the algorithm, if appropriate.
- give details of how testing is done, include testing-code/test-data or
testing-sequences used.
- comments and suggestions on future enhancements
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.}
UIT2201: CS & IT Revolution; (Spring 2003); A/P Leong HW