A system's design specification and supporting documentation should be almost as important as the system's implementation itself.
Users rely on high-level documentation to understand the big picture of how a system works.
Without spending time and effort to create palatable documentation, a user's only resource is the code itself, something the vast majority of users cannot understand.
Security assessments depend on a complete technical specification to understand the specifics of how a system works.
When a behavior is not specified (or is specified incorrectly), security assessments must base their knowledge in assumptions, leading to less effective review.
Maintaining and updating code relies on supporting documentation to know why the system is implemented in a specific way.
If code maintainers cannot reference documentation, they must rely on memory or assistance to make high-quality changes.
Currently, the only documentation for Growth DeFi is a single README file, as well as code comments.
Improve system documentation and create a complete technical specification.
- ConsenSys Audit Growth DeFi Finding 4.2
- Specification/Documentation
- Single README w/Code Comments
- Improve Specification & Documentation