diff options
Diffstat (limited to 'doc/development/changelog.md')
| -rw-r--r-- | doc/development/changelog.md | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/doc/development/changelog.md b/doc/development/changelog.md index c0296a6d75e..7dc3ae0a80b 100644 --- a/doc/development/changelog.md +++ b/doc/development/changelog.md @@ -1,7 +1,7 @@ --- stage: none group: unassigned -info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments +info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/product/ux/technical-writing/#assignments --- # Changelog entries @@ -114,7 +114,7 @@ making it both concise and descriptive, err on the side of descriptive. - **Bad:** Go to a project order. - **Good:** Show a user's starred projects at the top of the "Go to project" - dropdown. + dropdown list. The first example provides no context of where the change was made, or why, or how it benefits the user. @@ -126,9 +126,9 @@ how it benefits the user. Again, the first example is too vague and provides no context. - **Bad:** Fixes and Improves CSS and HTML problems in mini pipeline graph and - builds dropdown. + builds dropdown list. - **Good:** Fix tooltips and hover states in mini pipeline graph and builds - dropdown. + dropdown list. The first example is too focused on implementation details. The user doesn't care that we changed CSS and HTML, they care about the _end result_ of those |