Messy Technical Report
By kaichoukebz
@kaichoukebz (1190)
Philippines
December 9, 2011 7:17am CST
I am now taking English 9 in college. My professor scolded us last time and punished us to make an introduction to our technical report entitled "The Reconstruction of the Science Building". The Science Building is one of the most important buildings in our school.
He did not discuss to us the method or the manner on how we will make the introduction for our technical report. He only implied that we must follow the format in making the introduction to our technical report: first will be the "background", then the "scope", then the "statement of the problem".
I really need some techniques and procedures in making my technical report. It is truly hard for me as a beginner.
1 person likes this
1 response
@SpikeTheLobster (6399)
•
9 Dec 11
Technical writing is much more direct, boring and straightforward. There's little opportunity for opinion or creative flourishes - but that's why it's technical writing.
Going by what the professor suggests, you could construct a document as follows:
Background: A description of why the document exists, the Science Building and so on. Explain why the document exists (its purpose), where the building is, when it was built, etc. All the background information.
Scope: The document scope covers what's included. Analysis of the problem, suggested solutions, whatever else you'll put in. It also describes what's NOT in the document - so if you're only putting a problem description in, without any possible solutions, you would state that the document describes the issues but does not offer solutions.
Statement of the problem: This is the detailed analysis of the problem(s) that has lead to reconstructing the Science Building. Why did they have to do it? Take each problem in turn, analysing it.
(Possible) Solutions: If you're expected to suggest solutions (or they've already chosen one), you can cover it here. Detail all the solutions that could be/were considered.
Conclusions: Explain why the chosen solution was selected above the others (price, simplicity, ease of implementation, best solution, etc.). Detail how it solves the problem and an outline of how it will be implemented (not too much detail - that goes into another document unless the prof specifically asks for it).
There's an example technical report format at http://writing.colostate.edu/guides/documents/ce-trpt/pop2g.cfm (or a load of other places, just search). The parts you need will depend on how technical your prof is and how advanced the work is:
Unlikely to need: Transmittal Letter, Acknowledgments, Executive Summary (that's the background in this case), Table of Contents, Appendices (unless you have content from other sources you'd like to include).
Likely to need: Title Page, Abstract (that's the background), List of Figures and List of Tables (if you have diagrams and/or tables), Report Body, References (if you refer to anyone else's work in your report)
Hope it helps.
@kaichoukebz (1190)
• Philippines
9 Dec 11
I think, I need some revisions here. My background goes like this: The Science Building is one of the most important buildings at Western Institute of Technology. The building is used primarily for the purpose of feeding the minds of the students studying at Western Institute of Technology.
The Science Building at Western Institute of Technology provides discomfort to the students and faculty members of the said school. The discomfort had arose because of the defected, non-well-ventilated, and too old rooms at the Science Building. Students and faculty member are complaining about this issue.
The reconstruction of the Science Building is a massive tool in providing a convenient environment for the students and faculty members of Western Institute of Technology.
Scope: The proposal centers primarily with the reconstruction of the Science Building which includes ten classrooms, faculty room, two laboratory rooms, ASCCORD office, comfort rooms, and the guard house. The number of rooms will still remain the same though there is a re-positioning to happen. Also, there will be no relocation of the Science Building.
Statement of the Project Problem: This document proposes the reconstruction of the Science Building at Western Institute of Technology. The reconstruction is essential to provide finest possible educational environment for the students and faculty members of Western Institute of Technology.
Could you point out some of my errors? It is my first time to write a technical report. It is very difficult!
1 person likes this
@SpikeTheLobster (6399)
•
10 Dec 11
Without rewriting it, it's tough. I also don't know how long it needs to be - a tech report can be a simple summary (about the length you have already) or a detailed analysis of thousands of words. I'm not going to correct your English (except for one or two big things) because that's what the exercise is about. 
Background: "The Science Building is one of the most important buildings at Western Institute of Technology. The building is used primarily for the purpose of feeding the minds of the students studying at Western Institute of Technology."
I'd put a sentence in after the first, saying when it was built. Second sentence needs more precision. Something like "The building is used primarily for teaching (list of a few subjects) and other scientific subjects. The rooms are also used for (other uses like meetings or whatever, if there are any other uses)."
The problem: "The Science Building at Western Institute of Technology provides discomfort to the students and faculty members of the said school. The discomfort had arose because of the defected, non-well-ventilated, and too old rooms at the Science Building. Students and faculty member are complaining about this issue."
That's good. "non-well-ventilated" can be changed to "badly-ventilated", by the way. You can go into more detail. You mention that the rooms are too old - is the technical equipment outdated? Is the furniture old? What about the teaching materials? Lighting? Are the structural materials (walls, floors and ceiling) alright or do they need refurbishment as well?
"The reconstruction of the Science Building is a massive tool in providing a convenient environment for the students and faculty members of Western Institute of Technology."
I'd put that in the background, as a closing paragraph. It's not the problem but is a good introduction. You also re-state some of that in your "Statement of the Project Problem" so, by putting the above paragraph into the background introduction part, you separate it from the repeated part by a greater distance.
Scope: "The proposal centers primarily with the reconstruction of the Science Building which includes ten classrooms, faculty room, two laboratory rooms, ASCCORD office, comfort rooms, and the guard house. The number of rooms will still remain the same though there is a re-positioning to happen. Also, there will be no relocation of the Science Building."
This is excellent. I'd put the last sentence first, since it's important to the following parts (if the building was being relocated, everything would be different). Start with the big stuff and work down to the detail.
Statement of the Project Problem: "This document proposes the reconstruction of the Science Building at Western Institute of Technology. The reconstruction is essential to provide finest possible educational environment for the students and faculty members of Western Institute of Technology."
Excellent summary.
You can expand this part a great deal if you want to. What do you mean by reconstruction? The number of rooms stay the same but "re-positioning" will happen - do you mean moving walls, just re-numbering the rooms or re-purposing rooms by building new facilities inside? You could go into detail for each room if you wanted to (that's fine as a bullet list for easy reading). How does the work affect the building's wiring and plumbing - are there any changes to that or is it all above-ground and planned so that no major structural work is needed? What about environmental factors - have they been considered in things like better/cheaper lighting, power, heating and so on?
Hope it helps.
Background: "The Science Building is one of the most important buildings at Western Institute of Technology. The building is used primarily for the purpose of feeding the minds of the students studying at Western Institute of Technology."
I'd put a sentence in after the first, saying when it was built. Second sentence needs more precision. Something like "The building is used primarily for teaching (list of a few subjects) and other scientific subjects. The rooms are also used for (other uses like meetings or whatever, if there are any other uses)."
The problem: "The Science Building at Western Institute of Technology provides discomfort to the students and faculty members of the said school. The discomfort had arose because of the defected, non-well-ventilated, and too old rooms at the Science Building. Students and faculty member are complaining about this issue."
That's good. "non-well-ventilated" can be changed to "badly-ventilated", by the way. You can go into more detail. You mention that the rooms are too old - is the technical equipment outdated? Is the furniture old? What about the teaching materials? Lighting? Are the structural materials (walls, floors and ceiling) alright or do they need refurbishment as well?
"The reconstruction of the Science Building is a massive tool in providing a convenient environment for the students and faculty members of Western Institute of Technology."
I'd put that in the background, as a closing paragraph. It's not the problem but is a good introduction. You also re-state some of that in your "Statement of the Project Problem" so, by putting the above paragraph into the background introduction part, you separate it from the repeated part by a greater distance.
Scope: "The proposal centers primarily with the reconstruction of the Science Building which includes ten classrooms, faculty room, two laboratory rooms, ASCCORD office, comfort rooms, and the guard house. The number of rooms will still remain the same though there is a re-positioning to happen. Also, there will be no relocation of the Science Building."
This is excellent. I'd put the last sentence first, since it's important to the following parts (if the building was being relocated, everything would be different). Start with the big stuff and work down to the detail.
Statement of the Project Problem: "This document proposes the reconstruction of the Science Building at Western Institute of Technology. The reconstruction is essential to provide finest possible educational environment for the students and faculty members of Western Institute of Technology."
Excellent summary.
You can expand this part a great deal if you want to. What do you mean by reconstruction? The number of rooms stay the same but "re-positioning" will happen - do you mean moving walls, just re-numbering the rooms or re-purposing rooms by building new facilities inside? You could go into detail for each room if you wanted to (that's fine as a bullet list for easy reading). How does the work affect the building's wiring and plumbing - are there any changes to that or is it all above-ground and planned so that no major structural work is needed? What about environmental factors - have they been considered in things like better/cheaper lighting, power, heating and so on?
Hope it helps.@kaichoukebz (1190)
• Philippines
10 Dec 11
I now know what else to write on my technical report's introduction. It was truly very helpful. I will edit it as soon as possible because the submission of it will be on Tuesday.
1 person likes this
