ReadySetGit/Glossary.md

117 lines
3.5 KiB
Markdown
Raw Normal View History

2023-03-24 16:29:16 +00:00
<!-- markdownlint-disable-next-line first-line-h1 -->
2018-08-14 21:52:57 +00:00
**Process impact:** This file as a dictionary of terms defined as they
are used during the project. Writing out the definitions of terms and
acronyms here helps keep other documents more concise and precise. A
shared glossary helps prevent misunderstandings and makes it easier for
new team members to be productive.
2023-03-24 17:01:43 +00:00
<!-- markdownlint-disable link-fragments -->
2018-08-14 21:52:57 +00:00
Jump to: [A](#a) | [B](#b) | [C](#c) | [D](#d) | [E](#e) | [F](#f) |
[G](#g) | [H](#g) | [I](#i) | [J](#j) | [K](#k) | [L](#l) | [M](#m) |
[N](#n) | [O](#o) | [P](#p) | [Q](#q) | [R](#r) | [S](#s) | [T](#t) |
2018-08-23 17:23:45 +00:00
[U](#u) | [V](#v) | [W](#w) | [X](#x) | [Y](#y) | [Z](#z) |
2023-03-24 17:01:43 +00:00
<!-- markdownlint-enable link-fragments -->
[Standard terms](Glossary-Standard-Terms)
2018-08-14 21:52:57 +00:00
2023-03-24 17:01:43 +00:00
## Project-specific Terms
2018-08-14 21:52:57 +00:00
2023-03-24 16:29:16 +00:00
_TIPs:_
2018-08-14 21:52:57 +00:00
2023-03-24 16:29:16 +00:00
- _Define HTML anchors on your terms with id="TERMNAME" so that other
documents can link to the definition of specific terms._
- _If there is any question about the meaning of a term, note it here.
2018-08-14 21:52:57 +00:00
If someone (e.g., the customer) gave you a definition to use, note
that here too. If something is best defined by using a hyperlink to
2023-03-24 16:29:16 +00:00
another document or website, include a hyperlink in the definition._
- _If a term was used in the past, but is no longer going to be used,
2018-08-14 21:52:57 +00:00
you should keep it in the list, mark it as "deprecated", and link to
the term or terms that replace it. E.g., deprecated standard term
2023-03-24 16:29:16 +00:00
[bug](glossary-std.html#bug)._
- _Define only project-specific terms, or ones that a new team member
2018-08-14 21:52:57 +00:00
would not know. Don't define standard textbook terms that can be
2023-03-24 16:29:16 +00:00
easily found elsewhere._
- _This glossary can serve as simple domain model or data dictionary.
2018-08-14 21:52:57 +00:00
You can define important data objects by describing their meaning
and key attributes. For example, see [student](#student) and
2023-03-24 16:29:16 +00:00
[GPA](#gpa)._
2018-08-14 21:52:57 +00:00
2023-03-24 17:01:43 +00:00
### A
2018-08-14 21:52:57 +00:00
2023-03-24 17:01:43 +00:00
### B
2018-08-14 21:52:57 +00:00
2023-03-24 17:01:43 +00:00
### C
2018-08-23 17:23:45 +00:00
2023-03-24 17:01:43 +00:00
#### ::Class standing
2018-08-14 21:52:57 +00:00
- ::Computed attribute of [student](#student) based on number of
academic units completed. Used to determine priority in
course enrollment.
- ::Real-world meaning of values:
| | |
2023-03-24 16:29:16 +00:00
| ----------- | ------------------------------- |
2018-08-14 21:52:57 +00:00
| ::Freshman | ::Less than 90 units |
| ::Sophomore | ::Between 90 and 180 units |
| ::Junior | ::Between 180 and 270 units |
| ::Senior | ::More than 270 units completed |
2023-03-24 17:01:43 +00:00
### D
2018-08-14 21:52:57 +00:00
2023-03-24 17:01:43 +00:00
### G
2018-08-23 17:23:45 +00:00
2023-03-24 17:01:43 +00:00
#### ::GEF
2018-08-23 17:23:45 +00:00
2023-03-24 16:29:16 +00:00
::_n._ The [Graph Editing Framework](http://gef.tigris.org/). An open
2018-08-14 21:52:57 +00:00
source library for editing diagrams (boxes and arrows).
2023-03-24 17:01:43 +00:00
#### ::GPA
2018-08-23 17:23:45 +00:00
2023-03-24 16:29:16 +00:00
::_n._ Grade Point Average. GPA is a float between 0.00 and 4.00,
2018-08-14 21:52:57 +00:00
accurate to 2 decimal places. Computed from average of completed
course grades in transcript weighted by course units. Used to
determine student ranking, and to trigger Dean's List and
academic probation.
2023-03-24 17:01:43 +00:00
### I
2018-08-23 17:23:45 +00:00
2023-03-24 17:01:43 +00:00
#### ::ICS
2018-08-23 17:23:45 +00:00
2023-03-24 16:29:16 +00:00
::_n._ Acronym for the [School of Information and Computer
2018-08-14 21:52:57 +00:00
Science](http://www.ics.uci.edu/) at [UC Irvine](http://www.uci.edu/).
2023-03-24 17:01:43 +00:00
### S
2018-08-23 17:23:45 +00:00
2023-03-24 17:01:43 +00:00
#### ::Student
2018-08-23 17:23:45 +00:00
2023-03-24 16:29:16 +00:00
::_n._ A person who attends a school to earn a degree. Persistent
attributes include: student_id_number (primary key), GPA, major,
and years_at_school.
2018-08-14 21:52:57 +00:00
2023-03-24 17:01:43 +00:00
#### ::Senior
2018-08-23 17:23:45 +00:00
2023-03-24 16:29:16 +00:00
::_n._ A senior is special type of [undergraduate](#undergraduate) who
2018-08-14 21:52:57 +00:00
has a certain number of course credits on his or her transcript.
2023-03-24 16:29:16 +00:00
Years_at_school does not determine senior standing. TODO: how many
2018-08-14 21:52:57 +00:00
credits needed?
2023-03-24 17:01:43 +00:00
### T
2018-08-23 17:23:45 +00:00
2023-03-24 17:30:29 +00:00
#### ::Term1
2018-08-23 17:23:45 +00:00
2018-08-14 21:52:57 +00:00
::Definition1
2023-03-24 17:01:43 +00:00
#### ::Term2
2018-08-23 17:23:45 +00:00
2018-08-14 21:52:57 +00:00
- ::Definition2a
- ::Definition2b
2023-03-24 17:01:43 +00:00
#### ::Term3
2018-08-23 17:23:45 +00:00
2018-08-14 21:52:57 +00:00
::Definition3
2023-03-24 17:01:43 +00:00
### U
2018-08-23 17:23:45 +00:00
2023-03-24 17:01:43 +00:00
#### ::Undergraduate
2018-08-23 17:23:45 +00:00
2023-03-24 16:29:16 +00:00
::A type of [student](#student). _TODO: add more detail._