It is divided into sections which allow different readers to access different levels of information. This guide explains the commonly accepted format for a technical report; explains the purposes of the individual sections; and gives hints on how to go about drafting and refining a report in order to produce an accurate, professional document.
For technical reports required as part of an assessment, the following presentation guidelines are recommended;. There are some excellent textbooks contain advice about the writing process and how to begin see Section Here is a checklist of the main stages;. Who is going to read the report? In professional contexts, the readers might be managers, clients, project team members. The answer will affect the content and technical level, and is a major consideration in the level of detail required in the introduction.
Begin writing with the main text, not the introduction. Follow your outline in terms of headings and subheadings. Let the ideas flow; do not worry at this stage about style, spelling or word processing. If you get stuck, go back to your outline plan and make more detailed preparatory notes to get the writing flowing again. Make rough sketches of diagrams or graphs. Keep a numbered list of references as they are included in your writing and put any quoted material inside quotation marks see Section Write the Conclusion next, followed by the Introduction.
Do not write the Summary at this stage. This is the stage at which your report will start to take shape as a professional, technical document. In revising what you have drafted you must bear in mind the following, important principle;. During year 1, term 1 you will be learning how to write formal English for technical communication.
This includes examples of the most common pitfalls in the use of English and how to avoid them. Use what you learn and the recommended books to guide you. Most importantly, when you read through what you have written, you must ask yourself these questions;. It is often the case that technical information is most concisely and clearly conveyed by means other than words. Imagine how you would describe an electrical circuit layout using words rather than a circuit diagram. Here are some simple guidelines;.
The appearance of a report is no less important than its content. An attractive, clearly organised report stands a better chance of being read. Use a standard, 12pt, font, such as Times New Roman, for the main text.
Use different font sizes, bold, italic and underline where appropriate but not to excess. Too many changes of type style can look very fussy. Technically, That's not Technical The trashcan in my classroom caught on fire last week. One of my students had replaced the instructions on the extinguisher with the following: Extract the metallic pin in the like manner Odysseus extracted the Wooden Horse plan from his mind.
Think of the fire as a tree that you really need to chop down and the extinguisher as your ax. Much like a tender chicken must be roasted slowly, so must the fire extinguisher lever be pressed. Sweep the extinguisher from side to side much in the same way Emily Dickinson uses her many-colored broom. Technically, This Is Technical Writing Technical writing is a type of writing that helps someone solve a problem or acquire necessary information about a specific subject.
The following is an example on how to write technically: Know your audience - This is true for all types of writing. You must know to whom you are writing.
If you're writing, for example, an instruction manual on how to program a cell phone for the general public, you're going to use words that most people will understand. If you're writing the same manual for a group of software designers for Verizon Wireless, you're going to use more technical terms and more complex functions. Write an introduction - Keep the introduction short.
Let the reader know who needs to read it and why they need to read it. If the reader belongs to the "who" group and your "why" solves his problem, then you have just grabbed his attention. See the introduction to this how-to-example. Be direct - Readers of technical writing are not looking for a life-changing literary experience.
They have a problem. They want you to solve it. MRI cross-sections of the human body with explanations Manufacturing at the molecular level! Information and links to articles and websites about nanotechnology provided by Ralph C. Search for Extraterrestrial Intelligence Institute, an organization devoted to scientific and educational projects relating to life in the universe International Space Station.
Possibilities of time travel Human Genome Organisation. Provided by Arthur Kerschen of the University of Arizona, discussion and links related to genetic engineering—human cloning, in particular How to Clone a Human. Ideas for Technical-Writing Projects What's going on at work? Are the projects there, just waiting for you? Browse some of these ideas: Does the office need a new photocopy machine?
Are you considering a fax machine? Is the staff expected to use a new software application for which there is no user guide? Are you and other employees interested in telecommuting using electronic and computer methods to work at home? Is management considering putting all operating procedures and other administrative materials online?
Has your agency been challenged to go "paperless"—to get all files stored and searchable electronically? Have you been tasked with recommending a personal digital assistant, cell phone, or notebook computer for all employees in your company?
A good source for volunteer projects is Idealist at www. It lists 10, Web sites for non-profit organizations, information on volunteering, jobs, and projects. Inadequate public transportation Lack of parking Overflowing land fills Smog and otherwise dirty air Crowded streets and highways Crime, vandalism Homeless people Lack of daycare facilities Unemployment Lack of low-cost housing Dwindling water supplies Expensive electricity Natural areas threatened by urban development Lack of parks and recreational facilities Lack of facilities for the elderly Rodent infestations Mosquitoes Lack of vegetation trees, shrubbery, etc.
Projects for nonprofits Lack of facilities for young people Expensive water I would appreciate your thoughts, reactions, criticism regarding this chapter: Information and programs provided by hcexres prismnet. This work is licensed under a Creative Commons Attribution 4. Volunteer Opportunities Find a service-learning opportunity that involves some writing!
In particular, take a look at the volunteer opportunities. Topic Ideas for Technical-Writing Courses Peruse these topics—see if any possibilities for projects come to mind. Ideas for Audiences See if the following list of audiences brings to mind technical-writing projects. Academic and Workplace-Oriented Majors Consider interesting courses or projects related to your major or any of the following. Interesting Magazines and Journals Go to your local library or newsstand and flip through some of the following.
Interesting Websites Browse some these websites for ideas. From Waseda University Japan , its project to develop a humanoid robot. From the Seattle Robotics Society. News, software, links, introductory information about virtual reality. Lots of information about and links to solar-powered cars.
For the collection and distribution of objective UFO data.
As a writer in a technical writing course, you may need some strategies for finding topics for writing projects, which are provided in this section.
Report Topics List The following is a grab-bag of topic ideas for the technical report. If you think of some additional ones that ought to be listed here, send e-mail to [email protected]
Choose from + Topics! Communicating with Colleagues and Peers - Inc. Magazine "Communication experts and CEOs share their strategies for smooth communications with employees, making winning presentations to investors, writing and delivering speeches that get standing ovations, and much more.". Technical Report Writing and Presentations. 3 This type of technical report provides background on a topic--for example, solar energy, global warming, CD-ROM technology, a technical background report on the subject. Instructions These are probably the most familiar of all the types of reports.
What are some best topics for technical reports in electrical engineering? Update Cancel. ad by Toptal. Toptal: Hire the top 3% of freelance project managers. What is the best topic for a BBA report writing? Which are the best engineering fields? What is electrical engineer? Can you provide me some technical topics for ppt of electrical. Apr 19, · What are the best topics for writing a report? Update Cancel. ad by Grammarly. Report writing is an art which is different from all other types of technical structures for writing. What are the best topics for writing full length novels?