EngGuide Style Guide
From EngGuide
The EngGuide Style Guide is a manual for editors that aims to make the EngGuide easier to read for users. Please follow these guidelines when editing the EngGuide so that it may stay clean and usable for a long time to come. Much of this guide follows Wikipedia's guidelines for writing articles, so for more help refer to the Wikipedia's own Style Guide.
Contents |
Article Titles
Course Articles
The same convention is to be used for all course article titles, consisting of the course code followed by a hyphen, followed by the course name. The course code is capitalized, and each word in the name begins with a capital letter. For example:
ECOR1010 - Introduction To Engineering
Other Articles
For articles dealing with topics other than courses, make the title as clear as possible without making it too long or complicated. For example, instead of creating a page for How to configure your laptop to properly run C, use C (programming language) Help and create a new section of how to configure it. This will help keep the Guide clean and well structured.
General Information
Introduction
When writing an article about a specific course, first include the brief introduction which appears on the Carleton Website. For example, for AERO3002 - Aerospace Design And Practise:
'Design approach and phases. Design integration. Influence of mission and other requirements on vehicle configuration. Trade-off studies, sizing and configuration layout. Flight vehicle loads, velocity-load factor diagram. Structural design: overall philosophy, role in design process, methods.'
While these descriptions are generally not very useful, it is a formality to conform with the Faculty of Engineering. After this is done, you are free to include your own, more useful description. Refrain from including your own personal opinions in this section, such as how hard you think the course was, how bad the professor was, etc.
Statistical Information
After the introduction, please include the following information in point form:
- Is the course 0.5 or 1.0 credits?
- Grading Scheme (year, semester, professor):
- Tests (#tests) - (% of final grade), (exam replacement - yes/no?)
- Assignments (#assignments) - (% of final grade)
- Midterm - (%of final) grade
- Book - (which book)
- Is the book necessary, how expensive is it?
It is very important that this information is up to date, i.e. the grading scheme should always be the one of the latest version of the course taught. For this reason please indicate the year, semester, and the name of the professor next to the grading scheme.
Some professors have two grading schemes depending on how well the student does. If this is the case please include the other grading scheme as well.
Course Content
This is the body of the article. In chronological order a description of the major topics and sections in the course is to be included. Here you may include personal views on how hard each sections is, how much time should be devoted to studying it, how prevalent the material from the section is on the exam, any any other useful information directly pertaining to the topic.
Labs
List the labs (if any), estimate how hard they are and how long the write-up takes. Include a link to writing up lab reports on the EngGuide (pending).
Assignments
List the assignments (if any), estimate how hard they are and how long the write-up takes. Include any links in the 'Links' section, which you think help with the assignment.
Exam
Link to the CSES exam library, if the library contains that course's exam. Provide any useful information about the exam.
Personal Experiences
In this section include anything at all that you want which is related to the course. Please specify which year and semester you took the course, and who the professor was. Feel free to use informal language in this section. Try to keep reviews of professors off of this site, and on RateMyProfessors.com instead, though feel free to link to outside sources.
Referencing
All articles are to use IEEE referencing.
Links
In the links section provide all links you think may be useful, along with a brief description
Language
Please use formal language. Refrain from addressing or yourself (you, I). It is perfectly fine to use highly technical language since it is an Engineering guide.
