5 ms·
- in code: code-level context - in commits: changeset-level context - in jira: if you need to provide changeset-level context, point them to the MR/commit log
by yura 3y ago
- in code: code-level context
- in commits: changeset-level context
- in jira: if you need to provide changeset-level context, point them to the MR/commit log
- in confluence: high-level documentation
- in daily standups: status update; if you need to provide changeset-level context, point them to the MR/commit log
- in release notes: generate automatically from commit log
IMO duplication in documentation should be treated the same as in code – it should be avoided as much as possible.
- account42 3y agoAgreed except for > - in release notes: generate automatically from commit log Release notes are for a completely different audience and should be custom-tailored to that audience. They also shouldn't include changes that were reverted or made redundant by later changes in the same release. Sure, commits-as-change-log is better than no change log but still very very far from optimal.