Upgrade to Pro — share decks privately, control downloads, hide ads and more …

テキストマイニングを使って 今年1年のレビュー内容をふりかえってみた話

Sponsored · Ship Features Fearlessly Turn features on and off without deploys. Used by thousands of Ruby developers.
Avatar for Cybozu Cybozu PRO
December 21, 2022

テキストマイニングを使って 今年1年のレビュー内容をふりかえってみた話

「LINE Technical Writing Meetup vol. 19 ~ 年納め LT パーティ」発表資料
https://line.connpass.com/event/267692/

Avatar for Cybozu

Cybozu PRO

December 21, 2022

More Decks by Cybozu

Other Decks in Technology

Transcript

  1. 自己紹介 ぴよ(サイボウズ株式会社) _chick_p 今日話す人 🎤 お仕事 サイボウズ製品の UI テキストを書く 製品のヘルプページや開発者向けドキュメントを書く

    仲田 尚央(サイボウズ株式会社) naoh_nak ネタを考えた人 💭 お仕事 サイボウズ製品の UI テキストを書く 製品のヘルプページを書く 他の言語に展開する(ローカライズ) 2
  2. 今年の Pull Request のレビューコメントを分析 Pull Request 今年 ⾃分が作った レビュー コメント

    ⼊⼒ テキストマイニングツール Word Cloud 分析 レビューに関する キーワード TextVoice ふりかえりの対象 今年自分が編集したコンテンツに対する、メンバーからのレビューコメントの内容 やったこと Pull Requestからレビューコメントを取得し、テキストマイニングツールでキーワードを分析 5
  3. 分析結果 - 実際のコメントを紹介 係り受けがわかりにくいと、誤解しやすく翻訳もしづらい文になる ユーザーがつまづきやすいポイントをフォローする 想定読者にあわせて書きすぎない 自社製品ではないブラウザやOSの設定は書かない コンテンツのメンテナンスコストも上がる 2022年は 画像の代替テキストに注力していた

    技術支援ツールを使ってヘルプを読むユーザーもいる 1 係り受けを明示して、どんなチェックボックスかを示した方が翻訳しやすそうかなと思いました。 2 この部分も、事前設定でできると勘違いしやすい部分だと思うので、「事前設定では、ユーザー追加はできないんだよ」と案内して おくと良さそうです。 3 Storeで2段階認証を設定する方は、その機能を理解している人だと思うので、L.9はカットしてもよいかなと思いました。 4 VerによってUIが変わったりするでしょうし、画像消しません?弊社以外のサービスはサポート外というのもありますし。 5 この補足のタイトルからどんなエラーメッセージが出るかは明確なので、Altでは簡潔に案内するので良さそうです。 9
  4. おまけ:textlint のチェック結果 ルール名 エラー内容 回数 jtf-style/4.3.7.山かっこ<> 半角になっている、かっこが閉じられていない 533 jtf-style/4.2.6.ハイフン(-) 半角になっている

    158 jtf-style/4.3.5.二重引用符 対になっている 115 jtf-style/2.1.2.漢字 常用漢字じゃない 102 jtf-style/4.3.1.丸かっこ() 半角になっている、かっこが閉じられていない 34 ja-no-redundant-expression 冗長表現である 15 jtf-style/2.1.6.カタカナの長音 長音記号がない 8 prh 表記ゆれがある 5 @textlint-rule/require-header-id 見出し ID が振られていない 4 jtf-style/2.1.5.カタカナ 半角カタカナがある 3 jtf-style/4.2.4.中黒(・) 半角の中黒がある 3 jtf-style/4.3.3.かぎかっこ「」 全角になっている 1 jtf-style/2.2.1.ひらがなと漢字の使い分け ひらがなと漢字の使い分けが適切ではない 1 13