The 3 common ways for developers to document information about their work is:
- Comments
- When is this written: When the developer wants something to be clearly and immediately visible to all other developers
- When is this found: As soon as other developers are reading code, they will find these comments
- Commit messages
- When is this written: When the developer wants to explain the work involved in them making a change. Why a change was made, explanation of the
- When is this found: When other developers dig a big deeper on why or when a change was made - they will find these commit messages
- Tech Documentation