If you are not able to communicate with your users directly, consider how they would react to the results you have produced and what they would value from the actuarial report.
For all work, documentation along the way saves time and effort in report writing. While documenting, include everything but also think about why it was done and how the work and any results will be received by your users.
The documentation should allow you to remember where things came from, what issues were encountered, decisions made, uncertainties remaining, and actions recommended.
Set out in a way that the users understand.
"Good documentation is not just what, not just how, but also why… (it) is a more comprehensive picture of the model, the assumptions, and the thought processes behind the choices made."1
The following tips are taken from a useful article by Slope software on Good Actuarial Model Documentation Practices
Set a Documentation Standard
This will give you standards and practices you can employ, refine, and hold professionals accountable to. Don’t be afraid to let this document evolve over time.
Include what you’re supposed to do after a meeting to the 45 minutes you spent debugging that one add-in, make some notes when you’re finished; it doesn’t have to be super-detailed. You won’t have to divert time and mental energy away from your current projects to think about the past.
Create a Final Version after you’ve … (finished)
Go back through all your in-the-moment documentation, refresh your memory, and create a final, “pretty” version for your peers and supervisors. This will give you the opportunity to pull together all the disparate nuggets of wisdom scattered throughout however many pages you’ve been making notes on through the development and validation processes. Doing it right away will avoid that risk of knowledge erosion.
https://slopesoftware.com/2019/12/26/good-actuarial-model-documentation-practices/ accessed on 04-Sep-2021
Read the other blogs in this series on Good Actuarial Reports.