Skip to content

Terminology

Frank Matranga edited this page Jul 6, 2019 · 3 revisions

In order to remain consistent, there are a handful of terms that should be used in specific circumstances and they may differ between the frontend and backend.

"Assessments" and "Coursework"

Assignments AND Exams are separate models yet they share most of their properties. Its common to need to refer to an object that may be an assignment or an exam. The general term for an assignment or exam is assessment. Many of the API routes return updatedAssessment in their responses. This is to be used on the backend and frontend in terms of variables names, comments, etc.

When displaying to the user in the frontend, the term "Coursework" should be used as the general term and "Assignment" or "Exam" should be used instead of "assessment".

Good:

  • let assessments = [...];
  • logger.info('Updated assessment for user');
  • alert('Removed assignment!')

Bad:

  • alert('Removed assessment!')
  • <h1>Upcoming Assessments</h1>