ReadySetGit/Glossary.md
William Sandner 24b358f205 GFM changes
2018-08-14 20:24:23 +02:00

4.4 KiB

<html> <head> </head> Overview Project Plan Workflows Current <!-- Markdown content here --> <h1 id="user-content-glossary" dir="auto">Glossary</h1> <hr> <p dir="auto"><strong>Process impact:</strong> 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.</p> <p dir="auto">Jump to: <a href="#user-content-a">A</a> | <a href="#user-content-b">B</a> | <a href="#user-content-c">C</a> | <a href="#user-content-d">D</a> | <a href="#user-content-e">E</a> | <a href="#user-content-f">F</a> | <a href="#user-content-g">G</a> | <a href="#user-content-g">H</a> | <a href="#user-content-i">I</a> | <a href="#user-content-j">J</a> | <a href="#user-content-k">K</a> | <a href="#user-content-l">L</a> | <a href="#user-content-m">M</a> | <a href="#user-content-n">N</a> | <a href="#user-content-o">O</a> | <a href="#user-content-p">P</a> | <a href="#user-content-q">Q</a> | <a href="#user-content-r">R</a> | <a href="#user-content-s">S</a> | <a href="#user-content-t">T</a> | <a href="#user-content-u">U</a> | <a href="#user-content-v">V</a> | <a href="#user-content-w">W</a> | <a href="#user-content-x">X</a> | <a href="#user-content-y">Y</a> | <a href="#user-content-z">Z</a> | <a href="/Suborbital-Systems/ReadySetGit/src/commit/24b358f205606dd7bf7922e3cbf0b88a4314dde1/Glossary-Standard-Terms#standard_terms">Standard terms</a></p> <h3 id="user-content-project-specific-terms" dir="auto">Project-specific Terms</h3> <p dir="auto"><em>TIPs:</em></p> <ul dir="auto"> <li><em>Define HTML anchors on your terms with id=&quot;TERMNAME&quot; so that other documents can link to the definition of specific terms.</em></li> <li><em>If there is any question about the meaning of a term, note it here. 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 another document or website, include a hyperlink in the definition.</em></li> <li><em>If a term was used in the past, but is no longer going to be used, you should keep it in the list, mark it as &quot;deprecated&quot;, and link to the term or terms that replace it. E.g., deprecated standard term <a href="/Suborbital-Systems/ReadySetGit/src/commit/24b358f205606dd7bf7922e3cbf0b88a4314dde1/Glossary-Standard-Terms#bug">bug</a>.</em></li> <li><em>Define only project-specific terms, or ones that a new team member would not know. Don't define standard textbook terms that can be easily found elsewhere.</em></li> <li><em>This glossary can serve as simple domain model or data dictionary. You can define important data objects by describing their meaning and key attributes. For example, see <a href="#user-content-student">student</a> and <a href="#user-content-gpa">GPA</a>.</em></li> </ul> <h4 id="user-content-a" dir="auto">A</h4> <h4 id="user-content-b" dir="auto">B</h4> <h4 id="user-content-c" dir="auto">C</h4> <h5 id="user-content-class-standing" dir="auto">::Class standing</h5> <ul dir="auto"> <li>::Computed attribute of <a href="#user-content-student">student</a> based on number of academic units completed. Used to determine priority in course enrollment.</li> <li>::Real-world meaning of values:</li> </ul> <table> <thead> <tr> <th></th> <th></th> </tr> </thead> <tbody> <tr> <td>::Freshman</td> <td>::Less than 90 units</td> </tr> <tr> <td>::Sophomore</td> <td>::Between 90 and 180 units</td> </tr> <tr> <td>::Junior</td> <td>::Between 180 and 270 units</td> </tr> <tr> <td>::Senior</td> <td>::More than 270 units completed</td> </tr> </tbody> </table> <h4 id="user-content-d" dir="auto">D</h4> <h4 id="user-content-g" dir="auto">G</h4> <h5 id="user-content-gef" dir="auto">::GEF</h5> <p dir="auto">::<em>n.</em> The <a href="<a href="http://gef.tigris.org/" class="link">http://gef.tigris.org/</a>">Graph Editing Framework</a>. An open source library for editing diagrams (boxes and arrows).</p> <h5 id="user-content-gpa" dir="auto">::GPA</h5> <p dir="auto">::<em>n.</em> Grade Point Average. GPA is a float between 0.00 and 4.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.</p> <h4 id="user-content-i" dir="auto">I</h4> <h5 id="user-content-ics" dir="auto">::ICS</h5> <p dir="auto">::<em>n.</em> Acronym for the <a href="<a href="http://www.ics.uci.edu/" class="link">http://www.ics.uci.edu/</a>">School of Information and Computer Science</a> at <a href="<a href="http://www.uci.edu/" class="link">http://www.uci.edu/</a>">UC Irvine</a>.</p> <h4 id="user-content-s" dir="auto">S</h4> <h5 id="user-content-student" dir="auto">::Student</h5> <p dir="auto">::<em>n.</em> A person who attends a school to earn a degree. Persistent attributes include: student_id_number (primary key), GPA, major, and years_at_school.</p> <h5 id="user-content-senior" dir="auto">::Senior</h5> <p dir="auto">::<em>n.</em> A senior is special type of <a href="#user-content-undergraduate">undergraduate</a> who has a certain number of course credits on his or her transcript. Years_at_school does not determine senior standing. TODO: how many credits needed?</p> <h4 id="user-content-t" dir="auto">T</h4> <h5 id="user-content-term1" dir="auto">::Term1</h5> <p dir="auto">::Definition1</p> <h5 id="user-content-term2" dir="auto">::Term2</h5> <ul dir="auto"> <li>::Definition2a</li> <li>::Definition2b</li> </ul> <h5 id="user-content-term3" dir="auto">::Term3</h5> <p dir="auto">::Definition3</p> <h4 id="user-content-u" dir="auto">U</h4> <h5 id="user-content-undergraduate" dir="auto">::Undergraduate</h5> <p dir="auto">::A type of <a href="#user-content-student">student</a>. <em>TODO: add more detail.</em></p>
</html>