Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

不具合修正に関する追記 #1469

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
+19 −2
Open

不具合修正に関する追記 #1469

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
603037c
不具合修正に関する追記
kawakichi-desu Dec 25, 2024
664c708
改行などを反映
kawakichi-desu Dec 25, 2024
4051d84
Update src/content/articles/products/contents/release-note/releasenot…
kawakichi-desu Dec 26, 2024
64d8cce
Update src/content/articles/products/contents/release-note/releasenot…
kawakichi-desu Dec 27, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 19 additions & 2 deletions src/content/articles/products/contents/release-note/releasenotes.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,8 +38,7 @@ SmartHR Design Systemのガイドラインに準拠するための変更の場

### 不具合修正
不具合の修正について記載します。
どの画面、どのUIでどのような不具合が修正されたかを具体的に書きます。

どの画面、どのUIでどのような不具合が修正されたかを具体的に書きます。ただし、発生条件が複雑な場合かつ影響範囲が小さい場合などは、詳しく書かない判断をしても構いません。
不具合修正が複数ある場合は、箇条書きで記載します。

### 廃止した機能
Expand Down Expand Up @@ -161,3 +160,21 @@ SmartHR Design Systemのガイドラインに準拠するための変更の場

##### 例
UIのみの変更であり、検索結果や付与する権限については変更ありません。

### 補足：不具合修正は簡潔かつ具体的に書く
基本姿勢は[不具合修正の基本的な書き方](#h3-3)に記載している「どの画面、どのUIでどのような不具合が修正されたかを具体的に書く」です。
一文で簡潔に書くことが多い不具合修正は、短文ゆえに、書き方によっては本来影響のないユーザーに不安を与えかねない内容になる場合があります。
どの粒度で書くか、どのように書くか迷ったときは、以下の例を参考にしてください。

#### 良い例
##### 基本の書き方
- バックグラウンド処理詳細画面に表示される一部のエラーにおいて、CSVファイルの行数が表示されない不具合を修正しました。
- ◯◯機能でデータを同期するときに基本機能のデータに不整合があってもエラーにならないようにしました。
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

本題からそれたコメントなのですが、そもそも「基本機能のデータ不整合」はあってはならない（かなり不安になる話）なのでは…という気持ちになりました。例としてはふさわしくない気がしたのですがいかがでしょうか。

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🦀すぎるので差し替えます！ありがとうございます！

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- ◯◯機能でデータを同期するときに基本機能のデータに不整合があってもエラーにならないようにしました。
- 手続き画面に表示されるエラーメッセージに群市区符号／郡市区符号と誤った表記があったため、郡市区符号に修正しました。

@misatokondo こちらに差し替えます🙏


##### 発生条件が複雑な場合かつ影響範囲が小さい場合
- 源泉徴収票機能の検索が正しく絞り込めないことがある不具合を修正しました。
- 発生条件や影響範囲を「正しく絞り込めないことがある」と表現しています。

#### 悪い例
- CSVファイル関連の不具合1件を修正しました。
- 不具合1件を修正しました。
Loading