This talks about the "what" of the code, but you have to also convey the "why".
If you have a well understood problem space and a team that is up to speed on it, then the "why" is well established and the code is the "what".
However, there are often cases where the code is capturing a new area that isn't fully understood. You need to interleave an education of the "why" of the code.
I was once asked to clean up for release 10k lines of someone else's robotics kinematics library code. There weren't any comments, readmes, reference programs, or tests. It was just impenetrable, with no starting point, no way to test correctness, and no definition of terms. I talked to the programmer and he was completely proud of what he had done. The variable names were supposed to tell the story. To me it was a 10k piece puzzle with no picture! I punted that project and never worked with that programmer again.
If you have a well understood problem space and a team that is up to speed on it, then the "why" is well established and the code is the "what".
However, there are often cases where the code is capturing a new area that isn't fully understood. You need to interleave an education of the "why" of the code.
I was once asked to clean up for release 10k lines of someone else's robotics kinematics library code. There weren't any comments, readmes, reference programs, or tests. It was just impenetrable, with no starting point, no way to test correctness, and no definition of terms. I talked to the programmer and he was completely proud of what he had done. The variable names were supposed to tell the story. To me it was a 10k piece puzzle with no picture! I punted that project and never worked with that programmer again.