• Home
  • Editing Services
    • Business Editing
    • Plain Language Editing
    • Book Editing
  • Blog
  • About
    • Our work
  • Contact
Clearlingo Editing and Proofreading
  • Home
  • Editing Services
    • Business Editing
    • Plain Language Editing
    • Book Editing
  • Blog
  • About
    • Our work
  • Contact

How to structure your report to get the key points across

2/6/2022

 
Picture
Photo by Gabrielle Henderson on Unsplash

I’m sure we've all experienced the feeling when we've spent hours creating a detailed report with important information only for the reader to skim it and put it aside.

What if they missed an important point? How will they make a decision based on a quick skim read?

Or you write a short report on an issue with well-thought-out recommendations, and the reception is not as positive as you expected.

Most people don’t have spare hours to read each report that arrives on their desk. But they need to be able to find the important information quickly to make decisions.

The answer is to use the right structure for your content so that the important information will be read and understood. Once they have the key information, the reader can then decide whether they will need to read the entire report to fill in the detail.
​
Before you start
Before you even start writing, decide on a structure you think will work for your content. 

Write out the headings that you think you will need.
​
You may find that you need to adjust the structure and the headings to fit the content as it develops. But keep going back to check that the structure will still work.
​
​Tip: Create headings using Word Styles and open the navigation pane so  that you can see the structure at a glance as you write.

The structures 
Here are eight ways to structure your document so that the reader is more likely to find and understand the key points. These are not the only ways, and you may need to tailor them a little to fit your content, but they’re a useful start.

  1. Chronological order or narrative
  2. Problem–cause–solution
  3. Situation–objective–appraisal–proposal
  4. Telescoping
  5. Exposition
  6. Long report 
  7. Instructions for procedures
  8. Q & A format
​
Note: Structure doesn’t work alone. There are also design and language considerations to ensure that the important points are read and understood. You can find out more about how to use principles of plain language for readability in my plain language series.

​1.    Chronological order or narrative
This structure is included as it's good to know about, and it's useful in some situations and industries, but it's an example of what not to do. Avoid this structure for business documents. 

This structure is similar to that used for technical or scientific reports, and it is often the first format writers turn to. It follows the writer’s process of providing background information, doing the research, and coming to a conclusion.

However, this is the least user-friendly structure for busy people in a business environment.

While it may seem logical, this structure has the conclusions and recommendations at the end, which means that a reader has a lot of content to get through before they get to the information that’s important to them, and they may just skim it – missing the main points.

Here is the outline of the narrative structure:
Background
Provide the background information
Method
Describe how you did the research
​Research
Describe what you did in your research
​Findings
Describe what you found
​Conclusion
State what the findings mean
Recommendations
State what you think should happen and the expected result

​2.    Problem–cause–solution
This structure is useful for short reports or emails, especially if you need to acknowledge that a problem has occurred and make suggestions on how to fix it.

As soon as they start reading, the reader will feel satisfied that you understand the problem. This helps create a positive relationship between you and the reader, and will create better outcomes for both sides.
​
Here is the outline of the problem–cause–solution structure:
The problem
​Describe the problem 
The cause
Describe why and how it happened, and the implications
The solution
State the recommendations and expected result

3.    Situation–objective–appraisal–proposal
This format is similar to the problem–cause–solution format and is useful for short reports or emails that need to show a solution to a problem.

As before, it describes the problem first so that reader knows it is understood. But in this structure, the expected outcomes are stated next, not at the end, so that these are easily found near the beginning of the report. It gives the reader satisfaction that there will be an action with a good outcome before they read all the detail on the how, why and recommendations. 

Here is the outline for the situation–objective–appraisal–proposal structure:
Situation
​Describe the problem
Objective
State the expected outcome
Appraisal
Describe how and why it happened
Proposal
State the recommendations 

4.    Telescoping
This structure places the most important information first, then filters down to the least important information.

This format gives the reader the option to choose how much they need to read. The reader can understand the most important information first from the key information section, and then choose whether to read the discussion and details.

A longer report will need more than just three sections, so you can combine it with another structure such as a long report format.

On the left are the headings to use for a short report. The subheadings on the right are used to divide the three main headings.
Key information
Summary
​Conclusions
Recommendations
Discussion
Analysis and context
Evidence
Detail
​Background information
Processes
Research and findings
Analysis and detail

5.    Exposition
This is a traditional report format, and is often used by students. It builds an argument by identifying each issue and analysing it before coming to a conclusion.
​
However, in a business setting, it is best to use this structure in combination with the telescoping or problem–cause–solution structures so that the important information comes first.

School report format:
Introduction
Outline the topic
Point 1
Discuss the first point
Point 2
Discuss the second point
Point 3
Discuss the third point
Conclusion
State the findings and recommendations

In a longer report, exposition on its own is not complex enough to convey the detailed content needed to build an argument.

​Here is the exposition structure in combination with telescoping and problem–cause–solution:
Executive summary
Provide a detailed summary of the full report
Contents
Create a list of all the headings – make sure the headings say exactly what is in each section
Introduction
Describe the purpose, background, method and cost
Recommendations
Describe the findings and recommendations
Summary of point 1
Summarise the first point
Problem
Describe the problem
Cause
Describe the cause
Solution
State the solution
Summary of point 2
Summarise the second point
Problem
Describe the problem
Cause
Describe the cause
Solution
State the solution
Appendices
Only include if required

6.    Long report 
This is another structure that is useful for a detailed report or consultation.

You may want to write the discussion, conclusion and recommendations first, then write the summary and introduction once your main content is complete. As you research and write the report, the focus may change, meaning the summary may also change.

The recommendations come at the end in this format, but the summary should include enough detail that the reader can use it to understand the issues and recommendations quickly. This gives the reader the option to ignore the rest if they run out of time. The summary needs to cover the main issues, the conclusion and recommendations.
​
Each section, including the summary, can have subheadings (using one of the structures above) to make the content easier to find and follow.

Here is an outline of the long report structure:
Contents
Create a list of all the headings – make sure the headings say exactly what’s in each section.
Summary
Write a complete summary of the purpose, findings, conclusions and recommendations. A reader needs enough detail to make a decision or to decide whether they need to read the full report.
Introduction
Describe the purpose, background, method and cost. Don’t include conclusions or recommendations here.
Discussion
State the results, options and ideas.
Conclusion
Describe what you found from the discussion.
Recommendations
State recommendations on the basis of the conclusions.
Appendices
Only add if necessary.

7.    Instructions for procedures
If you are writing a technical manual or procedures for staff, a step-by-step process is useful. It needs to be clear, preferably by using principles of plain language, and show the order of the steps to be taken.
​
The introduction and context may be a paragraph or two, or just a heading and one sentence, depending on the purpose context of the instructions. For example, a sign above a piece of machinery will need to be brief, whereas staff procedures can include more detail.

Here's an outline of a set of instructions:
Introduction
Outline the purpose of the instructions
Context
State what the reader will need, e.g. materials
Step 1
State what to do first
Step 2
State what to do next
Step 3
State what to do last
Result
State what the result should be

8.    Q & A format
If you know that the reader will have a lot of questions, you can structure your content into a Q & A format, for example FAQs. You will need to anticipate the questions that the reader may have, and there is a risk that you leave something out. But it’s a good way to engage readers.

Using a question turns what would have been a boring heading into something more engaging. Using part of the question in your answer helps readers to follow the thought. And it’s OK to have one- or two-word answers if that’s all that’s needed.

Here’s an example of a Q & A format:
Question
Where can I get vaccinated?
Answer
You can get vaccinated at your local vaccination centre. Click on this link to find one near you.
Question
Can I still get vaccinated if I have had Covid?
Answer
Current guidelines are that you should wait 3 months after recovery before getting a COVID-19 vaccination.
Question
Do I need to bring my vaccination card to my vaccination?
Answer
Yes.

​What next?
Got an unruly report that needs to be whipped into shape, or some untidy copy that needs some TLC? Get in touch today to enquire about my business editing and plain language services.
​
For more information on how I can help you make your writing shine, please contact me.

I would love to hear from you.​

Comments are closed.

    Hi, I'm Marja! 

    You'll find all my advice about creating professional, 
    ​on-brand business writing here.

    I'm an editor and plain language specialist. I work with writers of business publications, government content and non-fiction books to create clear, user-friendly writing
    .

    For more information or enquiries, please see my website.​ I'd love to hear from you.

    Categories

    All
    Business Writing
    Editing
    General Editing
    Grammar
    New Zealand English
    Plain English
    Technical

    Previous Posts

    Plain language
    • ​What is plain language?
    • Why you should use plain language 
    • How to write in plain language
    • Empathy helps to write in plain language
    • Can you use jargon in plain language writing?  

    Business editing
    • How to write emails that get read
    • 5 benefits to outsourcing editing
    • ​How does an editor help your business
    • How to keep your organisation's writing on-brand
    • ​How to structure your report

    New Zealand English Series
    • How to use a semicolon
    • The 'singular they'
    • How to use italics
    • How to write numbers
    • How to write abbreviations
    • How to punctuate dialogue
    • hyphens, en dashes and em dashes
    • How to write times and dates
    • Possessives
    • Is our spelling different?
    • Burned vs Burnt
    • Using Māori words in English text
    • -ise vs -ize endings
    • Single or double quote marks
    • Punctuation inside or outside quotation marks?

    The Editing Process
    • How to write a non-fiction book that sells
    • How to write a book to promote your business
    • Copyright and Permissions
    • How much does editing cost?
    • How to self-publish your book in New Zealand
    • ​When is my book ready for publishing?
    • Types of editing
    • 5 things to tell your editor
    • The revision and editing process​
    • What are beta readers?
    • What to expect when you get your manuscript back
    • How to order the pages of a book
    • Fact checking fiction writing
    • ​Formatting your manuscript for submission
    • How long does it take to edit a book?

    General Editing
    • Why I belong to editing associations
    • How to write recipes for cookbooks and blogs
    • ​The basics of writing a cookbook

    Technical
    • How to use Tracked Changes in Word
    • How to use basic Word Styles
    • ​How to fix common formatting errors in Word
Talk to us today for professional editing and proofreading!

Telephone 
Mon
–Fri, 9am–5pm NZST
​027 407 1156 (mobile)

Email
​marja@clearlingo.co.nz
Services
Business Editing
Plain Language Editing​
Non-fiction Book Editing​
Information
Terms and Conditions
​Blog
Company
About
Our work
Contact
  • Home
  • Editing Services
    • Business Editing
    • Plain Language Editing
    • Book Editing
  • Blog
  • About
    • Our work
  • Contact