The Hidden Risks of Poor Documentation
Regardless of the complexity of the system you create, there will always be hidden nuances that are not immediately obvious. Every time you come back to it, you need to relearn it—search through the code, data assets, and sometimes even run experiments to make sure everything works as expected. Below, I will provide an example of documentation that saves a huge amount of time for everyone who works with this system. Vehicle Damage & Lighting Framework This document contains a set of rules that define how functionality should be developed and organized. Two sets of textures exist simultaneously: intact and damaged. Each damage zone has a corresponding mask used to reveal the damaged version of the material. Each damage event must include the index or indices of the damage zones, as well as the speed and direction at the moment of impact. The direction and speed are required for spawning particles. Each state is triggered by calling its corresponding function. Each function has an ...