Difference between revisions of "Contributing"
m (Added lead to the "References to Faculty and Copyrighted Material" section) |
m (Minor grammatical edits) |
||
Line 35: | Line 35: | ||
=== External Links === |
=== External Links === |
||
− | External links should be used when necessary. Links to Georgia Tech-affiliated websites are preferred. If information from an external site can be organized better on the wiki, make sure to include a proper citation when inserting the information. |
+ | External links should be used only when necessary. Links to Georgia Tech-affiliated websites are preferred. If information from an external site can be organized better on the wiki, make sure to include a proper citation when inserting the information. |
== Leads == |
== Leads == |
||
− | Every page should begin with a lead. A lead has no header and provides a short overview of the page |
+ | Every page should begin with a lead. A lead has no header and provides a short overview of the page. A lead should not exceed more than a few sentences. The first sentence of a lead must include the name of the page in boldface close to its beginning. |
== Categories == |
== Categories == |
||
Line 50: | Line 50: | ||
=== Contact Information === |
=== Contact Information === |
||
− | Avoid providing direct contact information concerning a subject; instead, link to the subject's personal or professional webpage |
+ | Avoid providing direct contact information concerning a subject; instead, link to the subject's personal or professional webpage if available. |
Do not post previous or current course syllabi as they contain contact information of professors and [[Teaching Assistants|teaching assistants]] (TAs). |
Do not post previous or current course syllabi as they contain contact information of professors and [[Teaching Assistants|teaching assistants]] (TAs). |
||
=== Copyrighted Material === |
=== Copyrighted Material === |
||
− | Do not post or link to copyrighted material without permission. This includes |
+ | Do not post or link to copyrighted material without permission. This includes but is not limited to pirated textbook links, current or previous assignments and assessments, etc. You may indicate the existence or non-existence of these resources, but do not mention where they are located. |
=== Honor Code === |
=== Honor Code === |
Revision as of 13:17, 8 June 2021
The guidelines for contributing to the GT Student Wiki provide a standard set of rules and conventions for all contributors to follow. Anyone may contribute to the wiki as long as they follow the guidelines.
Grammar
The wiki should be easily readable and written in plain English. An informal style should be avoided, but language should not be excessive.
General Guidelines
- Always use third person, complete sentences. Separate sentences with only a single space.
- Use title case for headers and titles.
- Never use contractions
Emphasis
Do not use boldface or all caps for emphasis. Only italics should be used for emphasis, and emphasis should not be overused.
Numerals
Single digit numbers should be written as words, while numbers above nine should be written as numerals, with exception for credit hours. Credit hours should always be written as numerals.
Abbreviations
Do not use abbreviations, slang, or other informal terms unless they are specific to a Georgia Tech program. For example, using AE for aerospace engineering is acceptable, while using "prof" for professor is unacceptable. The first use of an acceptable abbreviation on a page must always be followed by its reference in parenthesis.
Links
The use of links is important to the overall structure of the wiki. Internal links link to other pages in the wiki, including pages that have not been created yet, while external links link to pages not in the wiki.
General Guidelines
Do not include consecutive links separated only by a space. This includes course names, which should not have their associated major and number linked separately. For example, instead of saying "MATH 2551 is a course required by math majors", say "MATH 2551 is a course required by math majors". Headers should never include links.
All pages must be located on a direct path of links from the main page; no floating pages are allowed. For example, the mechanical engineering page can be found on the majors page, which can be found on the main page.
Internal Links
The first reference to another page on the wiki should always be linked, while subsequent references should not be linked. For example, if the MATH 1551 page states "This course is a prerequisite for MATH 1552, with MATH 1552 covering...", then only the first reference to MATH 1552 is linked. If the page does not exist yet, using a red link is acceptable.
If a topic or term contains too little content to be given its own page, include it in the glossary and link to its place in the glossary.
Always link to major pages unless referring specifically to a minor of the same name.
External Links
External links should be used only when necessary. Links to Georgia Tech-affiliated websites are preferred. If information from an external site can be organized better on the wiki, make sure to include a proper citation when inserting the information.
Leads
Every page should begin with a lead. A lead has no header and provides a short overview of the page. A lead should not exceed more than a few sentences. The first sentence of a lead must include the name of the page in boldface close to its beginning.
Categories
(coming soon)
References to Faculty and Copyrighted Material
The guidelines for references to faculty and copyrighted material ensure that the wiki maintains a serious tone.
Professors and Faculty
Do not post negative reviews or rants about professors. Positive or neutral comments about professors are allowed, and you may also link to professors' Rate My Professors pages.
Contact Information
Avoid providing direct contact information concerning a subject; instead, link to the subject's personal or professional webpage if available.
Do not post previous or current course syllabi as they contain contact information of professors and teaching assistants (TAs).
Copyrighted Material
Do not post or link to copyrighted material without permission. This includes but is not limited to pirated textbook links, current or previous assignments and assessments, etc. You may indicate the existence or non-existence of these resources, but do not mention where they are located.
Honor Code
All contributions must be consistent with Georgia Tech's honor code.