There is no set work report format since each one needs a unique style and structure.
This is based on common mistakes I have observed over a period of time. That is, technical writing in general. While a google search on the topic may churn out many hits, the following is tailored for IIT Kanpur students in particular.
I will first mention some general guidelinesthen the structure of the report. Based on these, I will recommend a possible strategy for producing high-quality reports which have high potential for being published.
General Guidelines These are some general things you should know before you start writing. I will try to answer the questions of the purpose of report writing, and the overall approach as well.
Purpose of a report: This is the central goal of report-writing. A report which is written for the sake of being written has very little value. Before you start writing your report, you need to have in mind the intended audience.
This has value, but only short-term. The next broader possibility is that your report is readable by your peers or your juniors down the line.
This has greater value since someone else can continue on your work and improve it, or learn from your work. In the best case possibility, your report is of publishable quality. That is, readable and useful for the technical community in general.
This can proceed in roughly three stages of continual refinement of details. First write the section-level outline, Then the subsection-level outline, and Then a paragraph-level outline. The paragraph-level outline would more-or-less be like a presentation with bulleted points.
It incorporates the flow of ideas. Once you have the paragraph-level flow of ideas, you can easily convert that into a full report, by writing out the flow of ideas in full sentences. While doing the paragraph-level outline, think also about a figures, b tables, and c graphs you will include as part of the report at various stages.
You will find that many things can be better explained by using simple figures at appropriate places. Another thing to nail-down while doing the paragraph-level outline is the terminology you will be using. I will talk about these in more detail after talking about the overall report structure.
Structure of a report The following should roughly be the structure of a report. Note that these are just guidelines, not rules. You have to use your intelligence in working out the details of your specific writing.
These are the most-read parts of a report. This is how you attract attention to your writing. The title should reflect what you have done and should bring out any eye-catching factor of your work, for good impact.
The abstract should be short, generally within about 2 paragraphs words or so total. The abstract should contain the essence of the report, based on which the reader decides whether to go ahead with reading the report or not. It can contain the following in varying amounts of detail as is appropriate: Most reports start with an introduction section.
This section should answer the following questions not necessarily in that order, but what is given below is a logical order.
What is the setting of the problem? This is, in other words, the background. In some cases, this may be implicit, and in some cases, merged with the motivation below.
What exactly is the problem you are trying to solve? This is the problem statement.
Why is the problem important to solve? This is the motivation.
In some cases, it may be implicit in the background, or the problem statement itself.Good Report is a Reliable Document The data collection, analysis and interpretation of the data, conclusions drawn and recommendations made in the report should be accurate so as to make the whole report reliable and dependable for future reference and also for policy decisions.
Tips for Writing a Good Report Title Should be clear and descriptive, but not too long. Ideally should state main result.
Introduction In about paragraphs, an introduction: 1) introduces the problem and describes why it is interesting; 2) summarizes what’s known about the problem, citing prior work; and 3) summarizes your approach.
Writing a data analysis report can seem like more of an art than a science, but there is a framework within which to do it effectively.
It doesn’t matter how good the analysis actually is if you don’t write in an easy to read manner. A good data report should be easy to read and free from jargon. Sep 02, · How to Write a Book Report. In this Article: Article Summary Researching and Outlining Your Report Writing the Body of Your Report Finishing Up Your Report Sample Book Report and Summaries Community Q&A Writing a book report may not seem fun at first, but it gives you a great chance to really understand a work and its author%().
The report consisted of three words, “Nailed, jailed, and bailed.” This humorous report became legendary in our department. We learned that to encourage good police report writing, it required that we define what it means for reports and documents to be clear, concise and well-organized.
the goal of writing is not an abstract notion of `good writing', but communication. Conversely, I also now realize that beautiful big words, written with beautiful handwriting (or great computer formatting), and even with perfect spelling, topic sentences, perfect grammar and all that, can be really bad writing.