From 603037cf6090f0813ec94e3e972d39df241be932 Mon Sep 17 00:00:00 2001 From: KAWAGUCHI Risa Date: Wed, 25 Dec 2024 16:38:18 +0900 Subject: [PATCH 1/7] =?UTF-8?q?=E4=B8=8D=E5=85=B7=E5=90=88=E4=BF=AE?= =?UTF-8?q?=E6=AD=A3=E3=81=AB=E9=96=A2=E3=81=99=E3=82=8B=E8=BF=BD=E8=A8=98?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../contents/release-note/releasenotes.mdx | 21 +++++++++++++++++-- 1 file changed, 19 insertions(+), 2 deletions(-) diff --git a/src/content/articles/products/contents/release-note/releasenotes.mdx b/src/content/articles/products/contents/release-note/releasenotes.mdx index e0b4c8481..c95aa22e1 100644 --- a/src/content/articles/products/contents/release-note/releasenotes.mdx +++ b/src/content/articles/products/contents/release-note/releasenotes.mdx @@ -38,8 +38,7 @@ SmartHR Design Systemのガイドラインに準拠するための変更の場 ### 不具合修正 不具合の修正について記載します。 -どの画面、どのUIでどのような不具合が修正されたかを具体的に書きます。 - +どの画面、どのUIでどのような不具合が修正されたかを具体的に書きます。ただし、発生条件が複雑な場合かつ影響範囲が小さい場合などは、詳しく書かない判断をしても構いません。 不具合修正が複数ある場合は、箇条書きで記載します。 ### 廃止した機能 @@ -161,3 +160,21 @@ SmartHR Design Systemのガイドラインに準拠するための変更の場 ##### 例 UIのみの変更であり、検索結果や付与する権限については変更ありません。 + +### 補足：不具合修正は完結かつ具体的に書く +基本姿勢は[不具合修正の基本的な書き方](#h3-3)に記載している「どの画面、どのUIでどのような不具合が修正されたかを具体的に書く」です。 +一文で簡潔に書くことが多い不具合修正は、短文ゆえに、書き方によっては影響のないユーザーに不安を与えかねない内容になる場合があります。 +どの粒度で書くか、どのように書くか悩ましいときは、以下の例を参考にしてください。 + +#### 例 +##### 基本の書き方 +- バックグラウンド処理詳細画面に表示される一部のエラーにおいて、CSVファイルの行数が表示されない不具合を修正しました。 +- ◯◯機能でデータを同期するときに基本機能のデータに不整合があってもエラーにならないようにしました。 + +##### 発生条件が複雑な場合かつ影響範囲が小さい場合 +- 源泉徴収票機能の検索が正しく絞り込めないことがある不具合を修正しました。 + - 発生条件や影響範囲を「正しく絞り込めないことがある」と表現しています。 + +#### 悪い例 +- CSVファイル関連の不具合1件を修正しました。 +- 不具合1件を修正しました。 \ No newline at end of file From 664c7086b3989e9110998b1878872204e02bce1a Mon Sep 17 00:00:00 2001 From: KAWAGUCHI Risa <65280580+kawakichi-desu@users.noreply.github.com> Date: Wed, 25 Dec 2024 16:50:36 +0900 Subject: [PATCH 2/7] =?UTF-8?q?=E6=94=B9=E8=A1=8C=E3=81=AA=E3=81=A9?= =?UTF-8?q?=E3=82=92=E5=8F=8D=E6=98=A0?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../products/contents/release-note/releasenotes.mdx | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/src/content/articles/products/contents/release-note/releasenotes.mdx b/src/content/articles/products/contents/release-note/releasenotes.mdx index c95aa22e1..4521122a5 100644 --- a/src/content/articles/products/contents/release-note/releasenotes.mdx +++ b/src/content/articles/products/contents/release-note/releasenotes.mdx @@ -38,7 +38,7 @@ SmartHR Design Systemのガイドラインに準拠するための変更の場 ### 不具合修正 不具合の修正について記載します。 -どの画面、どのUIでどのような不具合が修正されたかを具体的に書きます。ただし、発生条件が複雑な場合かつ影響範囲が小さい場合などは、詳しく書かない判断をしても構いません。 +どの画面、どのUIでどのような不具合が修正されたかを具体的に書きます。ただし、発生条件が複雑な場合かつ影響範囲が小さい場合などは、詳しく書かない判断をしても構いません。 不具合修正が複数ある場合は、箇条書きで記載します。 ### 廃止した機能 @@ -162,11 +162,11 @@ SmartHR Design Systemのガイドラインに準拠するための変更の場 UIのみの変更であり、検索結果や付与する権限については変更ありません。 ### 補足：不具合修正は完結かつ具体的に書く -基本姿勢は[不具合修正の基本的な書き方](#h3-3)に記載している「どの画面、どのUIでどのような不具合が修正されたかを具体的に書く」です。 -一文で簡潔に書くことが多い不具合修正は、短文ゆえに、書き方によっては影響のないユーザーに不安を与えかねない内容になる場合があります。 +基本姿勢は[不具合修正の基本的な書き方](#h3-3)に記載している「どの画面、どのUIでどのような不具合が修正されたかを具体的に書く」です。 +一文で簡潔に書くことが多い不具合修正は、短文ゆえに、書き方によっては本来影響のないユーザーに不安を与えかねない内容になる場合があります。 どの粒度で書くか、どのように書くか悩ましいときは、以下の例を参考にしてください。 -#### 例 +#### 良い例 ##### 基本の書き方 - バックグラウンド処理詳細画面に表示される一部のエラーにおいて、CSVファイルの行数が表示されない不具合を修正しました。 - ◯◯機能でデータを同期するときに基本機能のデータに不整合があってもエラーにならないようにしました。 @@ -177,4 +177,4 @@ UIのみの変更であり、検索結果や付与する権限については変 #### 悪い例 - CSVファイル関連の不具合1件を修正しました。 -- 不具合1件を修正しました。 \ No newline at end of file +- 不具合1件を修正しました。 From 4051d84a9a3ce5573723ace2cf5fa6ecd0b31a12 Mon Sep 17 00:00:00 2001 From: KAWAGUCHI Risa <65280580+kawakichi-desu@users.noreply.github.com> Date: Thu, 26 Dec 2024 10:22:36 +0900 Subject: [PATCH 3/7] Update src/content/articles/products/contents/release-note/releasenotes.mdx Co-authored-by: Yukako Yoneyama <67178846+hebikox@users.noreply.github.com> --- .../articles/products/contents/release-note/releasenotes.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/content/articles/products/contents/release-note/releasenotes.mdx b/src/content/articles/products/contents/release-note/releasenotes.mdx index 4521122a5..cb2f93766 100644 --- a/src/content/articles/products/contents/release-note/releasenotes.mdx +++ b/src/content/articles/products/contents/release-note/releasenotes.mdx @@ -161,7 +161,7 @@ SmartHR Design Systemのガイドラインに準拠するための変更の場 ##### 例 UIのみの変更であり、検索結果や付与する権限については変更ありません。 -### 補足：不具合修正は完結かつ具体的に書く +### 補足：不具合修正は簡潔かつ具体的に書く 基本姿勢は[不具合修正の基本的な書き方](#h3-3)に記載している「どの画面、どのUIでどのような不具合が修正されたかを具体的に書く」です。 一文で簡潔に書くことが多い不具合修正は、短文ゆえに、書き方によっては本来影響のないユーザーに不安を与えかねない内容になる場合があります。 どの粒度で書くか、どのように書くか悩ましいときは、以下の例を参考にしてください。 From 64d8cce75e3c9ecd71e6ba87f4617531634e162b Mon Sep 17 00:00:00 2001 From: KAWAGUCHI Risa <65280580+kawakichi-desu@users.noreply.github.com> Date: Fri, 27 Dec 2024 10:39:55 +0900 Subject: [PATCH 4/7] Update src/content/articles/products/contents/release-note/releasenotes.mdx Co-authored-by: kondo <129918338+misatokondo@users.noreply.github.com> --- .../articles/products/contents/release-note/releasenotes.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/content/articles/products/contents/release-note/releasenotes.mdx b/src/content/articles/products/contents/release-note/releasenotes.mdx index cb2f93766..949a0b38b 100644 --- a/src/content/articles/products/contents/release-note/releasenotes.mdx +++ b/src/content/articles/products/contents/release-note/releasenotes.mdx @@ -164,7 +164,7 @@ UIのみの変更であり、検索結果や付与する権限については変 ### 補足：不具合修正は簡潔かつ具体的に書く 基本姿勢は[不具合修正の基本的な書き方](#h3-3)に記載している「どの画面、どのUIでどのような不具合が修正されたかを具体的に書く」です。 一文で簡潔に書くことが多い不具合修正は、短文ゆえに、書き方によっては本来影響のないユーザーに不安を与えかねない内容になる場合があります。 -どの粒度で書くか、どのように書くか悩ましいときは、以下の例を参考にしてください。 +どの粒度で書くか、どのように書くか迷ったときは、以下の例を参考にしてください。 #### 良い例 ##### 基本の書き方 From d06a6b066c78205f60599dd7e4deab69f7f828b6 Mon Sep 17 00:00:00 2001 From: KAWAGUCHI Risa Date: Tue, 7 Jan 2025 17:21:26 +0900 Subject: [PATCH 5/7] =?UTF-8?q?=E4=BE=8B=E3=81=AE=E7=A7=BB=E5=8B=95?= =?UTF-8?q?=EF=BC=86=E8=AA=BF=E6=95=B4?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../contents/release-note/releasenotes.mdx | 34 ++++++++----------- 1 file changed, 15 insertions(+), 19 deletions(-) diff --git a/src/content/articles/products/contents/release-note/releasenotes.mdx b/src/content/articles/products/contents/release-note/releasenotes.mdx index 949a0b38b..18520db61 100644 --- a/src/content/articles/products/contents/release-note/releasenotes.mdx +++ b/src/content/articles/products/contents/release-note/releasenotes.mdx @@ -39,6 +39,20 @@ SmartHR Design Systemのガイドラインに準拠するための変更の場 ### 不具合修正 不具合の修正について記載します。 どの画面、どのUIでどのような不具合が修正されたかを具体的に書きます。ただし、発生条件が複雑な場合かつ影響範囲が小さい場合などは、詳しく書かない判断をしても構いません。 +短文で書くことが多いゆえに、書き方によっては本来影響のないユーザーに不安を与えかねない内容になる場合があります。どの粒度で書けばいいか迷ったときは、以下の例を参考にしてください。 + +#### 良い例 +- バックグラウンド処理詳細画面に表示される一部のエラーにおいて、CSVファイルの行数が表示されない不具合を修正しました。 +- ◯◯機能でデータを同期するときに基本機能のデータに不整合があってもエラーにならないようにしました。 + +##### 発生条件が複雑な場合かつ影響範囲が小さい場合 +- 源泉徴収票機能の検索が正しく絞り込めないことがある不具合を修正しました。 + - 発生条件や影響範囲を「正しく絞り込めないことがある」と表現しています。 + +#### 悪い例 +- CSVファイル関連の不具合1件を修正しました。 +- 不具合1件を修正しました。 + 不具合修正が複数ある場合は、箇条書きで記載します。 ### 廃止した機能 @@ -159,22 +173,4 @@ SmartHR Design Systemのガイドラインに準拠するための変更の場 ユーザーの関心事の場合、「できなくなること」や「変更点がないこと」も明記します。 ##### 例 -UIのみの変更であり、検索結果や付与する権限については変更ありません。 - -### 補足：不具合修正は簡潔かつ具体的に書く -基本姿勢は[不具合修正の基本的な書き方](#h3-3)に記載している「どの画面、どのUIでどのような不具合が修正されたかを具体的に書く」です。 -一文で簡潔に書くことが多い不具合修正は、短文ゆえに、書き方によっては本来影響のないユーザーに不安を与えかねない内容になる場合があります。 -どの粒度で書くか、どのように書くか迷ったときは、以下の例を参考にしてください。 - -#### 良い例 -##### 基本の書き方 -- バックグラウンド処理詳細画面に表示される一部のエラーにおいて、CSVファイルの行数が表示されない不具合を修正しました。 -- ◯◯機能でデータを同期するときに基本機能のデータに不整合があってもエラーにならないようにしました。 - -##### 発生条件が複雑な場合かつ影響範囲が小さい場合 -- 源泉徴収票機能の検索が正しく絞り込めないことがある不具合を修正しました。 - - 発生条件や影響範囲を「正しく絞り込めないことがある」と表現しています。 - -#### 悪い例 -- CSVファイル関連の不具合1件を修正しました。 -- 不具合1件を修正しました。 +UIのみの変更であり、検索結果や付与する権限については変更ありません。 \ No newline at end of file From ee14d2ce30dccdb7ccf1c93c2266bc3dd50cb294 Mon Sep 17 00:00:00 2001 From: KAWAGUCHI Risa <65280580+kawakichi-desu@users.noreply.github.com> Date: Tue, 7 Jan 2025 17:34:06 +0900 Subject: [PATCH 6/7] Update src/content/articles/products/contents/release-note/releasenotes.mdx Co-authored-by: nakata <139850100+nao-nakata@users.noreply.github.com> --- .../articles/products/contents/release-note/releasenotes.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/content/articles/products/contents/release-note/releasenotes.mdx b/src/content/articles/products/contents/release-note/releasenotes.mdx index 18520db61..3ad02e1dc 100644 --- a/src/content/articles/products/contents/release-note/releasenotes.mdx +++ b/src/content/articles/products/contents/release-note/releasenotes.mdx @@ -46,8 +46,8 @@ SmartHR Design Systemのガイドラインに準拠するための変更の場 - ◯◯機能でデータを同期するときに基本機能のデータに不整合があってもエラーにならないようにしました。 ##### 発生条件が複雑な場合かつ影響範囲が小さい場合 +「正しく絞り込めないことがある」のように発生条件や影響範囲を抽象化して表現するのも良いでしょう。 - 源泉徴収票機能の検索が正しく絞り込めないことがある不具合を修正しました。 - - 発生条件や影響範囲を「正しく絞り込めないことがある」と表現しています。 #### 悪い例 - CSVファイル関連の不具合1件を修正しました。 From c42003b92552adb525ed8d1b1afaed70354211b9 Mon Sep 17 00:00:00 2001 From: KAWAGUCHI Risa <65280580+kawakichi-desu@users.noreply.github.com> Date: Tue, 7 Jan 2025 17:38:21 +0900 Subject: [PATCH 7/7] Update src/content/articles/products/contents/release-note/releasenotes.mdx --- .../articles/products/contents/release-note/releasenotes.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/content/articles/products/contents/release-note/releasenotes.mdx b/src/content/articles/products/contents/release-note/releasenotes.mdx index 3ad02e1dc..d551dd1a2 100644 --- a/src/content/articles/products/contents/release-note/releasenotes.mdx +++ b/src/content/articles/products/contents/release-note/releasenotes.mdx @@ -43,7 +43,7 @@ SmartHR Design Systemのガイドラインに準拠するための変更の場 #### 良い例 - バックグラウンド処理詳細画面に表示される一部のエラーにおいて、CSVファイルの行数が表示されない不具合を修正しました。 -- ◯◯機能でデータを同期するときに基本機能のデータに不整合があってもエラーにならないようにしました。 +- 手続き画面に表示されるエラーメッセージに群市区符号／郡市区符号と誤った表記があったため、郡市区符号に修正しました。 ##### 発生条件が複雑な場合かつ影響範囲が小さい場合 「正しく絞り込めないことがある」のように発生条件や影響範囲を抽象化して表現するのも良いでしょう。