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

Merged
merged 7 commits into from
Jan 7, 2025
Merged

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

Changes from 6 commits
Commits
Show all changes
7 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
d06a6b0
例の移動＆調整
kawakichi-desu Jan 7, 2025
ee14d2c
Update src/content/articles/products/contents/release-note/releasenot…
kawakichi-desu Jan 7, 2025
c42003b
Update src/content/articles/products/contents/release-note/releasenot…
kawakichi-desu Jan 7, 2025
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
17 changes: 15 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,7 +38,20 @@ SmartHR Design Systemのガイドラインに準拠するための変更の場

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

Choose a reason for hiding this comment

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

「補足：不具合修正は簡潔かつ具体的に書く」の見出しに記載している内容はここに書くのでも良いかも？と思いました。
理由：

  • 「詳しく書かない判断をしても構いません。 」を読むと具体例が欲しくなるので、直後にあると良い
  • この内容は「要素別の具体的な書き方」という見出しのテーマと逸れる
Suggested change
どの画面、どのUIでどのような不具合が修正されたかを具体的に書きます。ただし、発生条件が複雑な場合かつ影響範囲が小さい場合などは、詳しく書かない判断をしても構いません。
どの画面、どのUIでどのような不具合が修正されたかを具体的に書きます。ただし、発生条件が複雑な場合かつ影響範囲が小さい場合などは、詳しく書かない判断をしても構いません。
#### 良い例
- バックグラウンド処理詳細画面に表示される一部のエラーにおいて、CSVファイルの行数が表示されない不具合を修正しました。
- ◯◯機能でデータを同期するときに基本機能のデータに不整合があってもエラーにならないようにしました。
##### 発生条件が複雑な場合かつ影響範囲が小さい場合
発生条件が複雑な場合かつ影響範囲が小さい場合、「正しく絞り込めないことがある」のように発生条件や影響範囲を抽象化して表現するのも良いでしょう。
- 源泉徴収票機能の検索が正しく絞り込めないことがある不具合を修正しました。
#### 悪い例
- CSVファイル関連の不具合1件を修正しました。
- 不具合1件を修正しました。

Copy link
Contributor Author

@kawakichi-desu kawakichi-desu Jan 7, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

@nao-nakata 🦀!! ありがとうございます。提案内容を反映しつつ、補足の文章も調整のうえ移動させてみたので再度ご確認をお願いします🙏

image

Copy link
Contributor

Choose a reason for hiding this comment

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

@kawakichi-desu
ありがとうございます。良さそうです！
細かい点だけ1点コメントを入れています。
https://github.com/kufu/smarthr-design-system/pull/1469/files#r1905075356

短文で書くことが多いゆえに、書き方によっては本来影響のないユーザーに不安を与えかねない内容になる場合があります。どの粒度で書けばいいか迷ったときは、以下の例を参考にしてください。

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

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

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

不具合修正が複数ある場合は、箇条書きで記載します。

Expand Down Expand Up @@ -160,4 +173,4 @@ SmartHR Design Systemのガイドラインに準拠するための変更の場
ユーザーの関心事の場合、「できなくなること」や「変更点がないこと」も明記します。

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