Technical dissemination and communication
A project does not end when the prototype works: it ends when another person, who has not been in the workshop, can understand it, reproduce it, maintain it or decide whether to buy it. That is the function of technical documentation, and writing it well is as much a part of engineering as calculating the part.
What documents does a project produce
Each technical document has a different reader, and confusing them produces texts that are of no use to anyone.
Explain what project technical documentation is and name three different documents that are typically produced, indicating who each one is aimed at.
Explain what project technical documentation is and name three different documents that are typically produced, indicating who each one is aimed at.
These sections of a project report are out of order: (a) budget, (b) introduction and objectives, (c) conclusions, (d) description of the chosen solution, (e) analysis…
These sections of a project report are out of order: (a) budget, (b) introduction and objectives, (c) conclusions, (d) description of the chosen solution, (e) analysis of alternatives, (f) bibliography and references. Put them in a logical order and explain in one sentence what each one contains.
For a signal-controlled junction project, explain the difference between the technical report, the specifications and the system user manual: what each contains and who…
For a signal-controlled junction project, explain the difference between the technical report, the specifications and the system user manual: what each contains and who uses it (the contractor, the commissioning authority, the maintenance team).
Drawings, sketches and figures
The technical drawing is the document with the most practical consequences: the part is made directly from it.
The diagram shows the stages a technical document goes through from being drafted to reaching its readers, but one of them is covered up. State which stage is missing…
The diagram shows the stages a technical document goes through from being drafted to reaching its readers, but one of them is covered up. State which stage is missing and explain what is done during it.
Explain what a technical drawing is and what minimum information its title block contains (title, scale, author, date, drawing number). Why should a workshop never…
Explain what a technical drawing is and what minimum information its title block contains (title, scale, author, date, drawing number). Why should a workshop never manufacture parts from a drawing without a title block?
Distinguish between a rough sketch, a detail sketch and a standardised drawing: what level of detail and rules does each follow, and in which project phase is it used?…
Distinguish between a rough sketch, a detail sketch and a standardised drawing: what level of detail and rules does each follow, and in which project phase is it used? Which of the three has contractual validity?
Technical rigour: data, citations and standards
A technical report rests on verifiable data, not on impressions.
In a technical report, the following sentence appears: "according to the internet, steel holds a lot". Point out two technical rigor issues with it, rewrite it correctly…
In a technical report, the following sentence appears: "according to the internet, steel holds a lot". Point out two technical rigor issues with it, rewrite it correctly using a reasonable value with units, and explain how the source would be cited in the references section.
In a report, you have a table with $300$ temperature measurements and a graph showing their daily evolution. Explain what goes into the body of the document and what…
In a report, you have a table with $300$ temperature measurements and a graph showing their daily evolution. Explain what goes into the body of the document and what goes into the appendices, what general rule determines the location of each item, and why cluttering the body with raw data hinders readability.
Explain how a technical standard (for example, a UNE-EN ISO) is cited in a report's references: what details identify it and how it differs from citing a book or a…
Explain how a technical standard (for example, a UNE-EN ISO) is cited in a report's references: what details identify it and how it differs from citing a book or a website. Why is the date of the cited standard relevant in engineering?
Technical register and version control
The style of a report is not an aesthetic detail: it makes it easier or harder for someone else to trust what they read.
Correct the style of these sentences from a report, applying an impersonal technical register: "I think the structure easily holds", "we have seen that the battery lasts…
Correct the style of these sentences from a report, applying an impersonal technical register: "I think the structure easily holds", "we have seen that the battery lasts a ton", "the part is made as explained on the internet". Explain the rule you apply in each correction.
During a technical audit of a solar pumping system for irrigation, the following note is found in the specifications sheet: "The tank is large and holds plenty of water.…
During a technical audit of a solar pumping system for irrigation, the following note is found in the specifications sheet: "The tank is large and holds plenty of water. The pump kicks hard to lift the water to the upper terrace". After installing a 1,5 kW pump without any further data, the PVC discharge pipe (PN 6) has burst due to overpressure, and the pump enters cavitation whenever the tank level drops below 0,5 m.
- a) Demonstrate which quantitative technical variables (quantities, SI units, and tolerances) were omitted in the original specification and how that ambiguity caused the mechanical failure and the overpressure in the installation.
- b) Rewrite the complete technical specification for the tank-pump-pipe assembly using standardised hydraulic engineering terminology (defining total dynamic head, nominal flow rate, required NPSH, nominal pressure rating, and usable volume), so that it constitutes a binding and unambiguous technical requirement.
A technical document passes through several reviewers. Explain what document version control is, what fields its revision table contains (version, date, author,…
A technical document passes through several reviewers. Explain what document version control is, what fields its revision table contains (version, date, author, description of change), and what risk exists if two people edit different copies at the same time.
Presentation, licences and accessibility
Documenting well is not enough if the final dissemination does not reach its reader clearly.
You have five minutes to give an oral defence of your final-year project to a panel. Propose a presentation structure with timings for each block and three style rules…
You have five minutes to give an oral defence of your final-year project to a panel. Propose a presentation structure with timings for each block and three style rules for the accompanying slides, justifying each decision.
Write the executive summary (maximum ten lines) for a project of your choice, following this outline: problem, proposed solution, technologies used, result achieved and…
Write the executive summary (maximum ten lines) for a project of your choice, following this outline: problem, proposed solution, technologies used, result achieved and a key figure. Then, justify why the summary is written last even though it appears at the beginning of the document.
Your team designs a modular sorting robot for a technology competition and publishes the project repository with three elements: 1) The microcontroller firmware source…
Your team designs a modular sorting robot for a technology competition and publishes the project repository with three elements:
1) The microcontroller firmware source code, which dynamically links to a motor control library licensed under GPLv3.
2) The parametric CAD models and STL manufacturing files of the structural parts.
3) The technical report and the assembly guide with original schematics and photographs.
Since no license file was included in the repository, a company downloads the project, commercializes the robot with closed-source software, and demands that you remove the images from the internet, claiming commercial rights over the product.
- a) Analyze the legal and exploitation situation of each of the three components in the absence of an express license (default copyright under Spanish legislation).
- b) Design a combined licensing strategy (selecting and justifying specific and compatible licenses for hardware, software, and documentation) that contractually requires any derivative to remain open-source, guarantees acknowledgment of your authorship, and allows the public to freely reproduce the hardware.