Sample Content for Documents

 

If the project you are carrying out is a software engineering project, you will find below suggestions about the content of the key documents. These suggestions are just given as an example and not binding by any means, but of course, your advisor will provide you with more guidance and suggestions more adequate and more appropriate for the needs of your specific senior project.

 

A sample conception document content as suggested by Boehm in his article” Anchoring the Software Process” is as follows:

 

 

 

A sample elaboration document content  --after the first phase-- as suggested by Boehm in his article” Anchoring the Software Process” is as follows:

 

  1. Development timeline (plan)
  2. Project Risks
  3. Use Cases
  4. Conceptual Model
  5. List of Requirements (functional and non-functional)
  6. System Sequence Diagram/Flow Charts
  7. Architectural Design/Circuit Diagram/Hardware Block Design
  8. Design Rationale
  9. Technologies Used
  10. Component State Chart(s)
  11. Test Plan, including test cases
  12. User Manual
  13. Test or Experimental Results

 

A sample elaboration final document content would be the revised section from previous document plus

 

  1. System Prototype
  2. Collaboration Diagrams
  3. Class Diagram or Schematic
  4. Risk Resolution/mitigation

 

Sample construction final document content would be as follows:

 

  1. Source code or completed implementation;
  2. Build and install scripts, and/or instructions for installing/deploying hardware;
  3. Deployment instruction;
  4. Test cases, including input, expected output, and test implementation;
  5. Test results for features implemented

 

Sample delivery document content would be structured as follows: