- Overview
- The Basic Structure of a Report
- Writing Each Type of Report
- Writing a Data-Driven Report
- Key Expressions for Report Writing
- Report Writing Checklist
- Common Mistakes and How to Fix Them
Overview
For an engineer, report writing is a skill as important as technical ability. A well-written report accelerates decisions and conveys technical results to leadership effectively. This article sets out how to write each type of English report, along with the expressions you need in practice.
The Basic Structure of a Report
A General-Purpose Report Structure
Most technical reports follow the structure below.
| Section | Purpose | Share of length |
|---|---|---|
| Executive Summary | The key conclusions | 5-10% |
| Background/Context | Background and purpose | 10-15% |
| Methodology | The approach taken | 15-20% |
| Findings/Results | The results of analysis | 30-40% |
| Recommendations | What you propose | 15-20% |
| Next Steps | Follow-up actions | 5-10% |
How to Write an Executive Summary
The executive summary is the most important section of the report. Leadership will often read nothing else.
Principles:
- Summarize the heart of the whole report in one page or less
- State the conclusion first and put the supporting evidence after it
- Use numbers and data freely
- Keep jargon to a minimum
Template:
Executive Summary
This report presents the findings of [subject of the analysis].
Over the past [time period], our team [work carried out].
Key findings include:
- [key finding 1] (quantified impact)
- [key finding 2] (quantified impact)
- [key finding 3] (quantified impact)
Based on these findings, we recommend [core recommendation].
Implementation is expected to [expected effect with metrics].
Writing Each Type of Report
Technical Report
Used for reporting system designs, technology evaluations, PoC results, and the like.
Structure:
1. Executive Summary
2. Problem Statement
3. Technical Background
4. Approach / Architecture
5. Implementation Details
6. Testing & Validation
7. Performance Results
8. Trade-offs & Limitations
9. Recommendations
10. Appendix (detailed data, code snippets)
Key expressions:
"The proposed architecture addresses the scalability bottleneck by..."
"Our evaluation of three candidate solutions revealed that..."
"Performance benchmarks indicate a 3x improvement in throughput."
"The primary trade-off is between latency and consistency."
Incident Report / Post-Mortem
The report you write after a production incident.
Structure:
1. Incident Summary
- Severity / Impact
- Duration
- Affected Services
2. Timeline of Events
3. Root Cause Analysis
4. Resolution
5. Impact Assessment
6. Action Items (with owners and deadlines)
7. Lessons Learned
Key expressions:
"At 14:23 UTC, our monitoring system detected elevated error rates on..."
"The root cause was identified as a misconfigured connection pool limit."
"The incident affected approximately 15,000 users over a 47-minute window."
"Mitigation was achieved by rolling back the deployment to version 2.3.1."
An example timeline:
Timeline:
- 14:23 UTC: Monitoring alert triggered for API error rate > 5%
- 14:25 UTC: On-call engineer acknowledged the alert
- 14:30 UTC: Root cause identified as database connection exhaustion
- 14:35 UTC: Connection pool limit increased from 50 to 200
- 14:40 UTC: Error rates returned to normal levels
- 14:45 UTC: Incident declared resolved
Weekly / Monthly Status Report
A report for sharing progress on a regular cadence.
Structure:
1. Summary / Highlights
2. Progress This Week
- Completed items
- In-progress items
3. Key Metrics
4. Risks & Blockers
5. Plan for Next Week
Key expressions:
"This week, the team completed 3 out of 5 planned milestones."
"Deployment frequency increased from 2x/week to daily."
"A potential risk is the dependency on the external vendor's API migration."
"We are on track to deliver the MVP by end of Q1."
Technical Evaluation Report
Reports a comparative evaluation when adopting a technology or selecting a tool.
Building the comparison table:
| Criteria | Solution A | Solution B | Solution C |
|-----------------|-----------|-----------|-----------|
| Performance | High | Medium | High |
| Cost | Medium | Low | High |
| Ease of Use | High | High | Low |
| Community | Large | Medium | Small |
| Integration | Native | Plugin | Custom |
Key expressions:
"After evaluating three solutions against our requirements, Solution A
emerged as the recommended choice."
"While Solution B offers lower cost, it lacks the scalability
required for our projected growth."
"The evaluation criteria were weighted based on team priorities."
Writing a Data-Driven Report
Let the Numbers Speak
A report is only as persuasive as the data behind it.
Before (weak):
"We significantly improved system performance."
"The new feature was well received by users."
"Deployment time was reduced."
After (strong):
"System latency decreased from 450ms to 120ms (73% reduction)."
"User satisfaction scores improved from 3.2 to 4.5 out of 5.0."
"Deployment time was reduced from 45 minutes to 8 minutes."
Expressions for Describing Data Visualizations
"As illustrated in Figure 1, error rates show a clear downward trend."
"The chart below demonstrates the correlation between cache hit ratio and response time."
"Table 2 summarizes the comparative performance across all three environments."
Key Expressions for Report Writing
Conclusions and Recommendations
"Based on our analysis, we recommend..."
"The data strongly suggests that..."
"Given the findings above, the optimal approach would be..."
"We propose a phased rollout starting with..."
Communicating Risk
"There is a moderate risk of... if [condition]."
"The primary concern is the potential impact on..."
"To mitigate this risk, we recommend..."
"This approach carries a low probability but high impact risk of..."
Next Steps
"The immediate next step is to..."
"We recommend proceeding with Phase 1 by [date]."
"Action items have been assigned with the following deadlines:"
"A follow-up review is scheduled for [date]."
Report Writing Checklist
Before You Write
- Who is the audience for this report (leadership or engineers)?
- What is the core message?
- Which data will you put forward as evidence?
After You Write
- Does the executive summary alone carry the core message?
- Is every claim backed by data?
- Is the jargon explained appropriately for the reader?
- Do the action items name an owner and a deadline?
- Are there any typos or grammatical errors?
Common Mistakes and How to Fix Them
| Mistake | Fix |
|---|---|
| Listing data with no conclusion | State the conclusion first in the executive summary |
| Overusing jargon | Add explanations pitched at the reader's level |
| Reporting results without numbers | Include concrete figures and comparison data |
| A report that runs far too long | Keep the essentials in the body and the detail in an appendix |
| Missing action items | Give concrete next steps with owners and deadlines |
Quiz: check your report writing skills
Q1. What is the single most important principle when writing an executive summary?
A: State the conclusion first and place the supporting evidence after it. Leadership will often read only the executive summary, so the essentials must fit within a single page.
Q2. What must an incident report (post-mortem) always include?
A: Incident Summary, Timeline, Root Cause Analysis, Resolution, Impact Assessment, Action Items (with owners and deadlines), and Lessons Learned.
Q3. How would you rewrite "We significantly improved performance" so that it is data-driven?
A: "System latency decreased from 450ms to 120ms (73% reduction)" — include the concrete figures and the rate of change.