Difference: SoftwareDevelopmentReport (5 vs. 6)

Revision 62024-01-12 - CathyBareiss

Line: 1 to 1
 
META TOPICPARENT name="CSC122SylF2021"

Software Development Report Requirements

Overview

Line: 64 to 64
 
  • Acceptance Testing report: This includes everything in the testing plan along with the achieved results and an indicator if the test was passed for each test case. If the software it is not at a stage where it can be tested, that should be explained here (in addition to the testing plan that would be used if the software could have been tested). This is typically the previous table with two additional columns
  • Estimation of time required: This is a good faith estimate as to how long it will take to write the software. This can often be a single sentence.
  • Analysis of time used: This is a statement of how long it took to write the software. Dividing that amount into the times spent designing, coding different components, testing, etc. is a good thing to do esp. as the software get more complex. This should also include a comparison to the estimation is one was previously made. This is normally a very short paragraph.
Changed:
<
<
  • Identification of outside resources used: This is required. If no outside resources were used, the it should state that no outside resources were used. Use of the textbook or lecture notes need not be documented. The same with using provided code. However, in the code itself, any outside code (including provided code) needs to have a comment indicating where it came from. This needs to include details as to what help was received. An example would be John Smith helps me understand how to declared a 2D array to be used for my tic-tac-toe board. Jan Doe help me with the logic to determine who won.
>
>
  • Identification of outside resources used: This is required. If no outside resources were used, the it should state that no outside resources were used. Use of the textbook or lecture notes need not be documented. The same with using provided code. However, in the code itself, any outside code (including provided code) needs to have a comment indicating where it came from. This needs to include details as to what help was received. An example would be John Smith helps me understand how to declared a 2D array to be used for my tic-tac-toe board. Jan Doe help me with the logic to determine who won. You must list the code that you received help for and explain how it works if it was done using things not covered in class. If this is not done, that code will receive no credit.
 
  • Potential security risks: This is a short bulleted list of potential security issues if there are any. Otherwise, indicate that none have been identified.
  • Security report: This is a bulleted list of all known possible security issues associated with the software and how they were address, if they were addressed. Any unaddressed issues should be identified with a short statement as to the risk involved.
  • Potential ethical implications: This is a short bulleted list of potential ethical issues if there are any. This includes ways the software could be used for good and/or bad. Otherwise, indicate that none have been identified.
 
This site is powered by the TWiki collaboration platform Powered by PerlCopyright © 2008-2026 by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding TWiki? Send feedback