FINAL PROJECT PROPOSAL: Magnus Opus and Exigence > Code Annotation for a Website Allowing Users to Update Database Information
Looking forward to this "bilingual" document. Is your code specialized enough that you have some concerns about privacy? Let me know so that we can ensure that you are protected.
Can you reach the seven sources threshold? Perhaps not. Yet, did you use GitHub or StackExchange for patterns or inspiration? Do you want to acknowledge tutorials or other places that helped you?
Let me know.
Can you reach the seven sources threshold? Perhaps not. Yet, did you use GitHub or StackExchange for patterns or inspiration? Do you want to acknowledge tutorials or other places that helped you?
Let me know.
November 29, 2018 |
Marybeth Shea
Audience: This review is written for people with both coding and non-coding experience and is meant to explain my code to them. (Experts and non-experts)
Context: This will be used as annotations for documenting my code for a computer science class project.
Purpose: The annotation will allow non-experts to understand how my code works and it will allow experts to change and improve the code.
Content: This annotation will focus on explaining the complexities and technicalities of my code in such a way that it would allow people make or theorize how to improve and add to it. Additionally, it will focus on explain the structure of the database being used and how this website functions in the greater scope of the application it supports.
Document Type: Mixed code and text in a text editor
Design/Format: Text will be written in prose while the code will be written with the formal structure for html and javascript code.
Citation Style: APA (Formal)