Fluent Essays

For the first milestone assignment in CS 499, you will complete a code review of the work that will serve as the starting point for the enhancements in your ePortfolio. This is the same work you identified in the ePortfolio selection and software design assignment completed in Module One. In Milestone One, you will take the next step. You will describe and critically analyze existing code and discuss in detail your plans for enhancement Completing this assignment will give you a strong foundation for the enhancements you will complete in CS 499.Note that you will complete Milestone One in video form and submit it as an MP4 file.To complete Milestone One, consider the following:First, carefully review the Milestone One Guidelines and Rubric document. You will need to fulfill all requirements and critical elements.In developing the content for your code review, be sure to use the Code Review Checklist document.View the Code Review Example video to better recognize the form and content of this assignment.The Screencast Guide document provides technical guidance including free tools that you can use to make your video.A key tip in producing a quality video is to have a script or at least a detailed outline of content to discuss. Be sure to develop a clear message and supportive details before recording the video. cs_499_milestone_one_guidelines_and_rubric.pdf cs499_code_review_checklist.pdf cs499_screencast_guide.pdf Unformatted Attachment Preview CS 499 Milestone One Guidelines and Rubric Code Review Overview: Code review is a standard practice in high-tech industries for improving deliverables and user experiences while ensuring that code is concise, thorough, well-commented, and ready for updates. In CS 499, you will conduct an informal code review of earlier work as a foundational step toward producing enhanced work for the ePortfolio. You will review the code of artifacts with the potential to exhibit your knowledge and skills in the following areas:    Software engineering and design Algorithms and data structure Databases As noted in the Final Project Guidelines and Rubric document, while you may choose one artifact for each category, it is also possible to demonstrate your knowledge and skills in multiple categories using the same multifaceted artifact. The code review is an opportunity to analyze the code in its current condition and to discuss how you plan to enhance the code during CS 499. Prompt: In this milestone, you will perform a code review and submit it as a video. You will discuss code that relates to three key computer science categories: software engineering and design, algorithms and data structure, and databases. In this code review, you will analyze existing code for weaknesses, limitations, and vulnerabilities and explain your plan for enhancements. While you should exhibit your best thinking, this code review should be considered an informal exercise through which you will advance the dialogue with your instructor concerning the deliverables that will be published to your ePortfolio. It is important, therefore, to stay relaxed and be yourself, while also representing yourself as a professional. Stay on topic, but do not focus on completing a flawless screencast or perfect presentation. Instead, focus your attention on content, and strive to be analytical in your approach and clear in your delivery. While you may not want to speak from a prepared script, you should prepare and use a detailed outline. Additional tools are available to help you succeed. Use the Code Review Checklist document to develop the content for your code review. For guidance on preparing a screencast video, see the Screencast Guide document. The Code Review Example video is also available; review it with care and take notes on the approach used as needed. Be sure to ask your instructor any questions, and do so as early as possible as you prepare this assignment. For CS 499, the code review is a walkthrough of existing code and planned enhancements. It should demonstrate the following critical elements for each category (software engineering and design, algorithms and data structure, and databases):    Existing functionality: Provide a detailed walkthrough of the existing code focused on the features and function of the existing code. Code Analysis: Target areas of improvement in areas such as structure, logic, efficiency, functionality, security, testing, commenting, and documenting. Enhancements: Provide a walkthrough of planned enhancements that address issues raised in the code analysis. Rubric Guidelines for Submission: Submit your code review as a video approximately 30 minutes in length. Critical Element Software Design/Engineering Existing Functionality Software Design/Engineering Code Analysis Software Design/Engineering Enhancements Algorithms and Data Structure Existing Functionality Algorithms and Data Structure Code Analysis Algorithms and Data Structure Enhancements Databases Existing Functionality Databases Code Analysis Databases Enhancements Presentation Quality Proficient (100\%) Provides a clear, complete description of existing code Analyzes existing code using relevant code review criteria to support clearly stated findings Clearly and concisely explains practical enhancements aligned with analysis findings Provides a clear, complete description of existing code Analyzes existing code using relevant code review criteria to support clearly stated findings Clearly and concisely explains practical enhancements aligned with analysis findings Provides a clear, complete description of existing code Analyzes existing code using relevant code review criteria to support clearly stated findings Clearly and concisely explains practical enhancements aligned with analysis findings Presentation is complete, wellorganized, clearly narrated, illustrated with relevant code, and conducted in an appropriate style Needs Improvement (75\%) Provides description that may not be clear or complete Analyzes existing code but may not use relevant code review criteria or findings may be not well supported or clearly stated Proposes enhancements, but enhancements may not be clearly explained, practical in scope of the course, or aligned with analysis findings Provides description that may not be clear or complete Analyzes existing code but may not use relevant code review criteria or findings may be not well supported or clearly stated Proposes enhancements, but enhancements may not be clearly explained, practical in scope of course, or aligned with analysis findings Provides description that may not be clear or complete Analyzes code but may not use relevant code review criteria or findings may be not well supported or clearly stated Proposes enhancements, but enhancements may not be clearly explained, practical in scope of course, or aligned with analysis findings Presentation may not be complete or wellorganized; narration may not be clear; illustrations with code may not be provided or not be relevant; or the style may not be appropriate for an informal code review in a professional setting Not Evident (0\%) Does not provide a description of existing code Does not provide an analysis of existing code Value 10 10 Does not provide an explanation of proposed enhancements 10 Does not provide a description of existing code Does not provide an analysis of existing code 10 Does not provide an explanation of proposed enhancements 10 Does not provide a description of existing code Does not provide an analysis of existing code 10 Does not provide an explanation of proposed enhancements 10 No presentation is provided 10 Total 10 10 100\% CS 499 Code Review Checklist Structure ❏ Does the code completely and correctly implement the design? ❏ Does the code conform to any pertinent coding standards? ❏ Is the code well-structured, consistent in style, and consistently formatted? ❏ Are there any uncalled-for or unneeded procedures or any unreachable code? ❏ Are there any leftover stubs or test routines in the code? ❏ Can any code be replaced by calls to external reusable components or library functions? ❏ Are there any blocks of repeated code that could be condensed into a single procedure? ❏ Is storage use efficient? ❏ Are symbolics used rather than “magic number” constants or string constants? ❏ Are any modules excessively complex and should be restructured or split into multiple routines? Documentation ❏ Is the code clearly and adequately documented with an easy-to-maintain commenting style? ❏ Are all comments consistent with the code? Variables ❏ Are all variables properly defined with meaningful, consistent, and clear names? ❏ Do all assigned variables have proper type consistency or casting? ❏ Are there any redundant or unused variables? Arithmetic Operations ❏ Does the code avoid comparing floating-point numbers for equality? ❏ Does the code systematically prevent rounding errors? ❏ Does the code avoid additions and subtractions on numbers with greatly different magnitudes? ❏ Are divisors tested for zero or noise? Loops and Branches ❏ Are all loops, branches, and logic constructs complete, correct, and properly nested? ❏ Are the most common cases tested first in IF- -ELSEIF chains? ❏ Are all cases covered in an IF- -ELSEIF or CASE block, including ELSE or DEFAULT clauses? ❏ Does every case statement have a default? ❏ Are loop termination conditions obvious and invariably achievable? ❏ Are indexes or subscripts properly initialized, just prior to the loop? ❏ Can any statements that are enclosed within loops be placed outside the loops? ❏ Does the code in the loop avoid manipulating the index variable or using it upon exit from the loop? Defensive Programming ❏ Are indexes, pointers, and subscripts tested against array, record, or file bounds? ❏ Are imported data and input arguments tested for validity and completeness? ❏ Are all output variables assigned? ❏ Are the correct data operated on in each statement? ❏ Is every memory allocation deallocated? ❏ Are timeouts or error traps used for external device accesses? ❏ Are files checked for existence before attempting to access them? ❏ Are all files and devices left in the correct state upon program termination? Screencast Authoring Tips Outline a Script First! • Start with a detailed outline, with a list of topics to cover. Keep it beside your monitor for easy access and visual cues. • State the goal and purpose of the video at the beginning. • Keep the tone conversational, but also ensure you use the same terms as the assignments discussed. • Read your outline aloud before recording to correct potentially awkward phrasing. Preparing to Record • Use an external microphone. Built-in microphones such as those commonly included in laptop displays are less desirable. • Avoid having lots of blank space in the recording area. • Place the microphone at least 6 to 8 inches away from you to avoid breaths and popping Ps. Do NOT lean toward the microphone to speak. It is best to record a sample and see how it sounds before you record final audio. If your keyboard is too loud, try placing the microphone stand and/or the keyboard on a towel or other soft fabric to muffle vibrations. Sit up straight and speak clearly. • Drink water before recording, and have some beside you in case you need it. Avoid coughing when possible, but if you must, leave space before and after the cough so it can be edited out. • Clear your desktop and close all other applications. Hide all files and icons from any area visible to the viewer. Change your background to something appropriate and neutral, preferably a cleaner, less cluttered design. Close applications such as Skype, email clients, internet browsers, and instant messengers that can be seen or heard. • Open all tabs, windows, and files you will need. • Prepare recording software to save as a high-resolution MOV file. When MOV is not available, use AVI. As a last resort, use MP4. Screencast Authoring Tips Preparing to Record (Continued) Clear desktop with simple background. Keep a glass of water nearby. Stay hydrated. Keep notes beside monitor for easy access. Microphone 6 - 8 inches from face. Ensure a quiet environment. Screencast Authoring Tips Recording • Ensure a quiet environment. Turn off any televisions (even in other rooms), and avoid recording while kids are playing. Silence your phone, bring the dog outside, and so on. • Avoid recording in large empty rooms. Opt for rooms with curtains on the windows, carpets on the floor, and, if possible, fabrics on the walls. Finished basements are often good options, provided there is not a lot of noise from above. • Avoid ‘um’s and ‘uh’s. • Strive for slower, more precise mouse movements. Delivery • Deliver in MOV format Potential Software When selecting software to use, ensure it fits the following requirements: • Video output has NO watermarks • Video outputs to MOV format. Output to AVI acceptable, but not preferred. Output to MP4 only as a last resort. • No time restraints on recording (this will interrupt recording and cause disconnect) Free software suggestions: • Quicktime (Mac) • CamStudio (PC) ... Purchase answer to see full attachment