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.

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
Open

Conversation

kawakichi-desu
Copy link
Contributor

@kawakichi-desu kawakichi-desu commented Dec 25, 2024

課題・背景

チケットは起票していませんでした!🙏

UI文言・ガイドライン定例で相談していた件です。
:docbase: ガイドライン・UI文言レビュー会 2024-12-12
:codi-md: 不具合修正どれくらい具体的に書くねん

やったこと

  • リリースノートの不具合修正・本文に関する追記をしました
  • 具体例については以下FBを反映しています。BIG KANSHA
    • from:inaba-san
      • 「ただし、発生条件が複雑な場合かつ影響範囲が小さい場合や、諸般の事情がある場合は、詳しく書かない判断をしても構わない。」は「ただし、発生条件が複雑な場合かつ影響範囲が小さい場合などは、詳しく書かない判断をしても構わない。」にしてもいいかもと思いました。諸般の事情に含まれるものをぼかすという方針はLGTMで、「諸般の事情」と書くことで割と何でもあてはまっちゃうので「など」で目立たなくしてもいいかなって
    • from:kero-san
      • めっちゃこまいのでPRレビューのときにアレしますが、「〜不具合を修正しました」という文末にまとめないといけないという意識から変な文章になっている例を割と見るので、この文末以外の例を載せてあげたい(kero)

やらなかったこと

  • 以下FBを鑑みて、不具合修正の「文章を見直す際のポイント」は、不具合修正だけに関わらない内容だったので、今回は反映しないことにしました🙏
    • from:kondo-san
      • 「文章を見直す際のポイント」のほうは、これだけだと抽象的でイメージしづらそうなので、ライティング講座とかで説明できればよいかも? 入れるとしたら、例文とセットで入れたい。(kondo)
    • from:hebiko-san
      • 文章を見直す際のポイント、不具合に限らないかも?と思ったので、なんか全体の話として入れられるとよさそう?

迷ったこと

  • 仲田さんからいただいたFBは、全体に関わる話なのでどう反映するかな〜〜〜と思い、一旦ステイしています🙏が、いい盛り込み方があったら反映したいのでお力を貸してくださいまし🙏
    • いつ(発生条件)、どこで(発生場所)、何が(発生現象)のように分解して具体的な書き方の例を出すといいのかな

動作確認

  • Previewでみてね。

追加部分のキャプチャ

がさっと追加したところ
スクリーンショット 2024-12-25 18 26 01
一文程度の追記をしたところ
スクリーンショット 2024-12-25 18 26 13

@kawakichi-desu kawakichi-desu requested a review from a team as a code owner December 25, 2024 07:41
Copy link

netlify bot commented Dec 25, 2024

Deploy Preview for smarthr-design-system ready!

Name Link
🔨 Latest commit 64d8cce
🔍 Latest deploy log https://app.netlify.com/sites/smarthr-design-system/deploys/676e056edd9f3b0008f0fb9f
😎 Deploy Preview https://deploy-preview-1469--smarthr-design-system.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link
Contributor

@misatokondo misatokondo left a comment

Choose a reason for hiding this comment

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

追記ありがとうございます!2箇所コメントを入れました🙏

#### 良い例
##### 基本の書き方
- バックグラウンド処理詳細画面に表示される一部のエラーにおいて、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.

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

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants