smarthr-design-system icon indicating copy to clipboard operation
smarthr-design-system copied to clipboard

Update data.mdx

Open INABAshina opened this issue 1 year ago • 2 comments

課題・背景

https://smarthr.atlassian.net/browse/SD-779

やったこと

  • 「ライティングガイドライン」の中身を「ライティング」ページに移動
  • 「ライティングスタイル」を「基本方針」に変更
    • 具体の表記ルール的なものは用字用語へ移動
  • 用字用語の内容を以下に変更。UIテキストにあるものも該当のものはこちらに移動。
    • 索引
    • 用字一覧
      • 漢字とひらがなの使いわけ
      • カタカナ語の表記
      • 数字・数えの表記
      • 記号の表記
    • 用語一覧
      • SmartHRの用語
      • コンポーネントの呼び方
      • 操作を表す用語
      • その他類似する用語の使いわけ
    • 「使い方」として各ページに載っている内容と見る順番を提示するページを追加
    • コンポーネントなどにあるUIテキストに関わるライティングを「ライティング>UIテキスト」のガイドラインとしてまとめる

やらなかったこと

  • ヘルプセンターは別のPRで作業予定
  • 関係するコンポーネントへのリンク設置も別のPRで作業予定

動作確認

キャプチャ

Before After

INABAshina avatar Jul 08 '24 04:07 INABAshina

Deploy Preview for smarthr-design-system ready!

Name Link
Latest commit 95e7cd9957bf06ffcf4f0ae87189f4b3d48500a5
Latest deploy log https://app.netlify.com/sites/smarthr-design-system/deploys/67064706776877000815ce99
Deploy Preview https://deploy-preview-1242--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.

netlify[bot] avatar Jul 08 '24 04:07 netlify[bot]

error-messages.mdxの修正対象外の部分についてnice to haveな修正があったのでコメントします🍵

  • 51行目:フラッシュメッセージ→FlashMessage ※ここだけカナ表記
  • 93行目:FlashMessage(非推奨)で伝える要素は、原因または原因・対処です。
    • 「(非推奨)」部分、リンク先のタイトルと合わせて入れるようにしますか?

kawakichi-desu avatar Sep 10 '24 07:09 kawakichi-desu

@INABAshina 組み換え作業ありがとうございます! 「ヘルプページ」配下のコンテンツを確認し、リンクが古いところにいくつか修正コミット入れました🙏

misatokondo avatar Sep 18 '24 01:09 misatokondo