update assignment to groups of engineers

Purdue Online Writing Lab Purdue OWL® College of Liberal Arts

Writing Engineering Reports

Welcome to the Purdue OWL

This page is brought to you by the OWL at Purdue University. When printing this page, you must include the entire legal notice.

Copyright ©1995-2018 by The Writing Lab & The OWL at Purdue and Purdue University. All rights reserved. This material may not be published, reproduced, broadcast, rewritten, or redistributed without permission. Use of this site constitutes acceptance of our terms and conditions of fair use.

This powerpoint presentation provides information about how to write reports in Engineering.

This resource is enhanced by a PowerPoint file. If you have a Microsoft Account, you can view this file with   PowerPoint Online .

This PowerPoint slide presentation covers major aspects of writing reports in Engineering. Click on the link above in the Media box to download the slides.

The presentation includes information about:

• Report purpose and planning
• Report format and organization
• Headings and language
• Visual design
• Source documentation
• Finishing touches

Check out the Purdue YouTube Channel for vidcasts on writing engineering reports.

Leveling up your reporting as an engineering manager

In partnership with

As an engineering manager, you’re responsible for communicating your team’s performance to more senior folks in your organization.

These reporting sessions should tell your manager everything they need to know about how your team is getting on. They should deliver a clear and concise picture of your progress and flag the areas where you need support.

But building and creating an effective report is far from easy. That’s why we brought together a small group of engineering managers to discuss the common challenges and share their best practices for getting reporting right.

The roundtable session also included a presentation from Roman Dupais, Director of Engineering at Code Climate, on the importance of reporting for engineering and the wider business.

In this article, we’ve captured the highlights so you can learn to level up your reporting too!

Using reporting to improve transparency and communication

Reporting isn’t just for your boss. Effective reporting can help you plan strategically, own your goals, and advocate for what your team needs. In this talk, Romain Dupais shares his recipe for a great report, helping you to create transparency for both engineering and the company at large. Check out the video below.

What are the biggest reporting challenges for managers?

A great report tells the story of a team and is backed up by meaningful metrics, but that can be easier said than done. Here are some of the biggest challenges for engineering managers, according to our participants:

• Understanding what senior leaders are looking for in a report
• Figuring out what to focus on e.g. people vs. technical vs. business updates
• Getting the right balance between showcasing engineering wins and surfacing problems
• Identifying the right metrics to measure engineering performance, and finding tools to track those metrics
• Relating engineering metrics to wider business metrics if they aren’t obviously aligned

What information should managers include in their reports?

Because one of the biggest challenges is knowing what to share with senior stakeholders, we asked our engineering managers what information they’re currently reporting. Here are the things they’ve found helpful to include:

• Metrics around team and project health, velocity (e.g. X number of Y shipped per week), capacity, and tech debt
• Updates on projects including status, completion dates, and results
• Current and upcoming risks facing your team, sharing initial investigations and providing evidence that issues are not related to a lack of effort
• Updates on team goals for the current period and looking ahead
• Any concerns that have an impact on the organization beyond your team
• Celebrations of the positive work going on with your individual reports and their reports
• Any sense of trends between individual pieces of engineering work
• Your observations on the wider business
• Updates on recruitment efforts

Key takeaways

There’s no one-size-fits-all approach to reporting, but our discussion surfaced a few ways managers can set themselves up for success. Start by working with your own manager to set expectations on what should be reported. Remember that a great report includes a range of metrics – from progress and risks to organizational health and people – but those metrics should always be contextualized in terms of the human beings behind them; first and foremost, you’re telling a story. Finally, don’t forget to share what you’ve been working on personally; this is an opportunity to advocate for yourself, as well as your team. Good luck!

Related content

A buyer’s checklist for software developer analytics tools.

5 mistakes to avoid when choosing a software developer analytics tool

The best software development analytics tools 2024.

CONTENT SPONSORED by LINEARB

4 free engineering slides that win over boardrooms

CONTENT SPONSORED by SPLIT

How feature measurement promotes productivity and happiness

What McKinsey got wrong about developer productivity

CONTENT SPONSORED by CODE CLIMATE

Validating soft skills with hard data

Setting goals and using metrics that motivate

What the top 10% of dev teams look like in 2023

Keep your delivery in balance with these metrics pairings

Don’t let metrics be a distraction

Why elite dev teams focus on pull-request metrics

CONTENT SPONSORED by JELLYFISH

What recent data tells us about developer productivity and team health

How business alignment works in high-performing engineering teams

Using cooperative gaming to drive positive engineering change.

The workflow metrics that make elite dev teams

CONTENT SPONSORED by SHOPIFY ENGINEERING

Using success metrics to foster autonomy in engineering teams

CONTENT SPONSORED by PAGERDUTY

Want to accelerate incident response? Empower customer service teams.

How to level up your reporting as an engineering director

Five engineering KPIs to consider for your next board meeting

CONTENT SPONSORED by AIRBRAKE

Five things you need to know about setting the right goals for engineering teams

Reporting to the board as an engineering leader: secrets to success.

Making goals a habit: A guide to reaching engineering goals

Four best practices for leveraging data responsibly

Why engineering teams should stop counting agile story points, four ways to empower your team through data.

CONTENT SPONSORED by HONEYCOMB

Using SLOs to align business and engineering goals

Five mistakes to avoid when setting OKRs for your team

Balancing delivery speed with engineering health

Getting your engineers engaged with OKRs

Using metrics to communicate the state of your engineering org

Engineering metrics at every level: an engineering director’s guide, how managers can use metrics to improve planning and run better standups.

How to foster data-driven tech leadership

How Netlify, Splice, Code Climate, and more use engineering metrics

What engineering leaders should be measuring

The ‘flawed five’ engineering productivity metrics

The importance of effective status reports

How to run a great incident post-mortem

CONTENT SPONSORED by LIGHTSTEP

A primer on the OpenTelemetry collector

The health of your business depends on the health of your engineering team

Using metrics to remove bottlenecks and support your team, how to develop engineering metrics with people, process, and tools in mind, creating efficient, accurate, software estimations.

How synergy between product and engineering can solve the problem of software estimation

Taking a fresh look at setting objectives and key results for your engineering team

Plug in to LeadDev

Want to get regular updates on all things LeadDev? Sign up to our mailing list

To find out more about how your data is handled check out our Data Promise