I am a senior software engineer working in a department with two teams:
- One team (model team) is responsible for the creation of forecasting models.
- The other team (my team) is responsible for the implementation of these models.
Once I complete the implementation of the model, I send the model team the software, including an internal validation report explaining clearly what calculations are implemented.
The model team is now publishing my software along with the documentation explaining the forecasting model. This sign-off request is totally legitimate as I have the expertise to confirm that the implementation coincides with the documentation.
The tricky part comes at this stage:
- The documentation is very badly written with many inconsistencies.
- Since I am doing the review, they expect me to do all the work to rewrite the documentation and correct the inconsistencies.
- Once I complete the review, they want 1-2 meetings to be sure that they understand the documentation correctly.
I don't find this situation acceptable. What is the best way to react to it?
My initial idea is to send back the documentation to the model team with a list of the biggest mistakes (with the boss in cc) and ask for an updated document before I start the review.
Are there other possible solutions?