Recommended Specification Outline

Software projects
 

1. Introduction and motivation. Placement of the problem in the broader research area. Why is this project worth working on? Why is it original? Why is it practical?

2. Language, platform, and compiler used for a primary implementation (e.g., GNU C under Unix). The program portability to other platforms.

3. Additional software required (e.g., a library of arithmetic operations on large numbers, cryptographic library, etc.).

4. Detailed specification of the input and output of the program(s), including the exact format of input/output files.

5. Brief description of the function performed by the program(s), including any specific references to standards and detailed descriptions of algorithms in the literature.

6. Procedures for testing the functionality and performance of the program(s). Source of test vectors.

7. Plan of experiments to be performed using the program(s).

8. Time schedule, including the detailed intermediate goals to be achieved by the dates of the progress reports.

9. A list of possible areas, where the specification can change depending on the progress of the project.

10. Tentative table of contents of your final report.

11. List of literature.

12. Anything else you consider important.

Hardware projects

1. Introduction and motivation. Placement of the problem in the broader research area. Why is this project worth working on? Why is it original? Why is it practical?

2. Design entry method (e.g., VHDL, Verilog, AHDL, etc.), target implementation (e.g., Xilinx or Altera FPGA, ASIC semi-custom standard-cell circuit), CAD tools used to specify, implement, and verify the design (e.g., Aldec Active-HDL, Synplicity Synplify Pro, Xilinx ISE, Altera Quartus II, ModelSim, Synopsys).

3. Additional libraries of basic digital circuits required (e.g., Xilinx LogiBlox, TSMC library, etc.).

4. Detailed specification of the input and output of the circuit(s).

5. Brief description of the function performed by the circuit(s), including any specific references to standards and detailed descriptions of algorithms in the literature.

6. Procedures for testing the functionality and performance of the circuit(s), including

   • a. The simulator in use.

   • b. The source of test vectors.

   • c. The format of input stimuli (e.g., VHDL test bench, simulator script). 

   • d. Performance parameters to be determined by simulation (e.g., throughput, key setup time, time to encrypt one block, time to switch keys). 

   • e. Parameters to be determined using the implementation tools (e.g., number of CLBs in the FPGA implementation, minimum size FPGA device able to hold the device, area of the circuit in the standard-cell implementation).

7. Plan of simulation experiments to be performed using the circuit(s).

8. Time schedule, including intermediate goals to be achieved by the dates of progress reports.

9. A list of possible areas, where the specification can change depending on the progress of the project.

10. Tentative table of contents of your final report.

11. List of literature.

12. Anything else you consider important.
     

Analytical projects

1. Introduction and motivation. Placement of the problem in the broader research area. Why is this project worth working on? Why is it original? Why is it practical?

2. List of alternative protocols/algorithms/implementations you are planning to compare.

3. Detailed description of problems/hypotheses you are planning to investigate.

4. A tentative list of questions you will be seeking an answer to.

5. Procedure for verifying the results of your investigation.

6. Time schedule, including intermediate goals to be achieved by the dates of progress reports.

7. A list of possible areas, where the specification can change depending on the progress of the project.

8. Tentative table of contents of your final report.

9. List of literature.

10. Anything else you consider important.