Skip to main content

PERF Report Template

Context

What plugin / part of the project is this perf report about ?

  • is it a new version ?
  • is it testing different scenarios ?

Objective

Clearly define what is the objective of this report. Writting a perf report without an objective is just writting something that nobody will ever read.

The objectives of a perf report can be simple things like :

  • check if there was no regression between two versions.
  • check if the changes we implemented have a positive impact on perfomarnce.

Core of the report

The core of the report should contain answers to the objective cited above, usualy you will have sceenshots of grafana dashboard or other data visualisation along with an explanatory text on what the different sceenshots means.

Conclusion

A small conclusion reiterates the context and answers the question defined in the objective part.

Follow-up

At the end of the report you should always include a small follow-up on what the report told you on the current state of the project.

It should reflect what the next steps for the projects are and whether or not any change should be made on them after the conclusion of this repport.