Abstract[edit | edit source]

Short abstract describing the project from background to conclusion

Background[edit | edit source]

Describe the background of the project. Make sure to cover who, what, why, when and where…

Problem statement[edit | edit source]

Start your project objective statement in the format, "The objective of this project is to..."

Criteria[edit | edit source]

Include a brief intro to the criteria and then include a table with constraints and weights (0-10 highest). Feel free to use the code from examples, such as CCAT pedal powered TV#Evaluation Criteria.

Grading Criteria for previous sections:

  • Formatting (should look good, sortable table for criteria) +2
  • Thoroughness of content (who, what, when, were, etc.) +4
  • Considers audience (this will be read by people around the world and in the future, consider things such as there is more than one Santo Domingo) +3
  • Extra (e.g. images) +1

Literature Review[edit | edit source]

Introduce the literature review briefly and then use heading and subheadings for topics. This should focus on information… NO PLAGIARISM![1] Copy and paste from this Practivistas India/literature review template.

Grading criteria for Literature Review:

  • Formatting +1
  • Spelling, grammar, etc. (even when this is not explicitly stated as a criteria, it is expected) +2
  • Credibility (at least 1 book, 1 peer reviewed journal article, and many credible web references per student) +3
  • Thoroughness and relevance (at least 3 very project relevant topics per student) +3
    • Remember engineering 215 students must use technical writing
  • Extra (e.g. amazing sources, beautiful writing, above and beyond topic coverage, etc.) +1

Construction[edit | edit source]

Very complete description of how final project is made. This large section should have lots of pictures. Please consider making a timeline in addition or instead. Use the Help:Images#Galleries and probably Template:How to (e.g. Barrel O' Fun Worm Bin Instructions).

Timeline[edit | edit source]

Introduce the timeline and include a table of the timeline.

Grading criteria for timeline:

  • Spelling and grammar +2
  • Completeness of timeline +4
  • Table formatting +1
  • Timeline introduced +2
  • Separate columns for proposed and actual completion date. +1

Costs[edit | edit source]

Description of costs, donations, the fact that this is just proposed, etc. See for a very nice looking table format.

Grading criteria for costs:

  • Formatting (should look good, see formatting) +2
  • Thoroughness and up-to-dateness of budget (should display necessary components, including donations, have an introduction, etc) +4
  • Mathematical accuracy +3
  • Extra (sortable, etc) +1

Operation[edit | edit source]

This is how to operate. It should have a brief introduction and very useful images with labels. Also it may work best for your project to use the step by step how to template {{How to}}. See #Troubleshooting for an example.

Maintenance[edit | edit source]

Introduce this maintenance section.

Schedule[edit | edit source]

This is when to maintain what.

  • A daily task
  • A daily task
  • a weekly task
  • a weekly task
  • a monthly task
  • a monthly task
  • a yearly task
  • a yearly task
Every __ years
  • task
  • task

Instructions[edit | edit source]

This is how to use and maintain it. The step by step how to template {{How to}} is most likely best for this part.

Descriptive caption.

Do something.

Descriptive caption.

Do something really complicated but made simple, etc.

Conclusion[edit | edit source]

Testing results[edit | edit source]

Describe the testing results.

Discussion[edit | edit source]

Discuss the testing results.

Lessons learned[edit | edit source]

Discuss lessons were learned during this project and what you would do different next time.

Next steps[edit | edit source]

Discuss any next steps for the project as it goes on into the future.

Troubleshooting[edit | edit source]

This is only how to troubleshoot basic operation. For complex issues, the solution might just say contact ________. It should be a table in this format:

Problem Suggestion
Example issue Example solution or suggestion
Does not turn on Make sure it is plugged in
Another issue Et cetera

Team[edit | edit source]

Introduce team and semester in the following format:

Grading criteria for the remaining sections:

  • Grammar and spelling +1
  • Formatting +1
  • Depth, breadth and accuracy of content +7
  • Project documentation's potential for impact (e.g. reproduction) +1

References[edit | edit source]

Make sure to include other relevant categories at the bottom, e.g.,, etc.

FA info icon.svg Angle down icon.svg Page data
Authors Lonny Grafman
License CC-BY-SA-3.0
Language English (en)
Related 0 subpages, 17 pages link here
Impact 214 page views
Created June 6, 2014 by Lonny Grafman
Modified June 9, 2023 by Felipe Schenone
Cookies help us deliver our services. By using our services, you agree to our use of cookies.