5 ms·
> The latter is typically the realm of requirements, design documentation, and possibly test plans. You forgot one of the biggest spots for "why" documentation
by eikenberry 3y ago
> The latter is typically the realm of requirements, design documentation, and possibly test plans.
You forgot one of the biggest spots for "why" documentation... git commit messages, where the point is to say why you made this change. Maybe taking into account the commit messages around the code in question would help.
- smokel 3y ago"Initial commit" is my goto commit message. Still a great idea, though. Ingesting all data from JIRA may be beneficial as well.
- eikenberry 3y agoYep... and the why of that message is apparent and makes perfect sense for the first commit. If you only ever start projects and never work on them again, that is all you need.
- colordrops 3y agoIf you don't use proper commit messages you also probably don't have proper docs
- levelforge 3y agoWe already do that and more at Maru.ai - reach out if you're interested.