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

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

Transcript

1. テキストマイニングを使って
   今年1年のレビュー内容をふりかえってみた話
   サイボウズ株式会社
   ぴよ
   仲田 尚央
   

   View Slide

2. 自己紹介
   ぴよ（サイボウズ株式会社） _chick_p
   今日話す人 🎤
   お仕事
   サイボウズ製品の UI テキストを書く
   製品のヘルプページや開発者向けドキュメントを書く
   仲田 尚央（サイボウズ株式会社） naoh_nak
   ネタを考えた人 💭
   お仕事
   サイボウズ製品の UI テキストを書く
   製品のヘルプページを書く
   他の言語に展開する（ローカライズ）
   2
   

   View Slide

3. 今日のおはなし
   テキストマイニングを使って、今年 1 年で自分が編集した記事へのレビューコメントを分析して、今年をふりかえって
   みた
   きっかけ
   3
   

   View Slide

4. ヘルプサイトにおけるコンテンツの作成フロー
   サイボウズでは、GitHub でヘルプサイトのコンテンツを管理している
   詳細：プロダクトのヘルプサイトをマークダウンに移行した話 | Cybozu Inside Out
   GitHub
   Reviewer
   Pull Request
   コメント &
   承認
   公開
   投稿
   Writer
   Web
   4
   

   View Slide

5. 今年の Pull Request のレビューコメントを分析
   Pull Request
   今年 ⾃分が作った
   レビュー
   コメント ⼊⼒
   テキストマイニングツール
   Word Cloud
   分析
   レビューに関する
   キーワード
   TextVoice
   ふりかえりの対象
   今年自分が編集したコンテンツに対する、メンバーからのレビューコメントの内容
   やったこと
   Pull Requestからレビューコメントを取得し、テキストマイニングツールでキーワードを分析
   5
   

   View Slide

6. 分析結果
   6
   

   View Slide

7. 分析結果 - ワードクラウドにしてみた（絞込前）
   レビューコメントにおけるキーワードの出現頻度から、ワードクラウドを作成
   画面文言や製品の機能名がノイズになった
   レビューに関するキーワードだけに絞り込むことにした
   7
   

   View Slide

8. 分析結果 - ワードクラウドにしてみた（絞込後）
   レビューに関するキーワードだけに絞り込んで、ワードクラウドを作成
   ライティングのテクニックに関するキーワードより、記載した内容に言及するキーワードが目立つ
   例：案内、カット など
   8
   

   View Slide

9. 分析結果 - 実際のコメントを紹介
   係り受けがわかりにくいと、誤解しやすく翻訳もしづらい文になる
   ユーザーがつまづきやすいポイントをフォローする
   想定読者にあわせて書きすぎない
   自社製品ではないブラウザやOSの設定は書かない コンテンツのメンテナンスコストも上がる
   2022年は 画像の代替テキストに注力していた 技術支援ツールを使ってヘルプを読むユーザーもいる
   1
   係り受けを明示して、どんなチェックボックスかを示した方が翻訳しやすそうかなと思いました。
   2
   この部分も、事前設定でできると勘違いしやすい部分だと思うので、「事前設定では、ユーザー追加はできないんだよ」と案内して
   おくと良さそうです。
   3
   Storeで2段階認証を設定する方は、その機能を理解している人だと思うので、L.9はカットしてもよいかなと思いました。
   4
   VerによってUIが変わったりするでしょうし、画像消しません？弊社以外のサービスはサポート外というのもありますし。
   5
   この補足のタイトルからどんなエラーメッセージが出るかは明確なので、Altでは簡潔に案内するので良さそうです。
   9
   

   View Slide

10. まとめ（1/2）
    やったこと
    テキストマイニングを使って、今年編集したコンテンツに対するレビュー内容をふりかえってみた
    ふりかえってみて
    "テクニカルライティング"といえば、ライティングのテクニックが印象に残りやすいかも
    一文一義、係り受け など
    実際のレビューは、記載する内容に言及することが多い
    何を書くべき／書かないべき
    読み手を意識した、内容の取捨選択
    ヘルプページに書いてある = サポート対象になる
    アクセシビリティへの配慮
    （再掲）レビューコメントだけに絞込した後のワードクラウド
    10
    

    View Slide

11. まとめ（2/2）
    来年にむけて
    読者を考慮して、書くべき／書かないべきの取捨選択をより意識する
    来年もふりかえってみて、ワードクラウドのキーワードの変化を確認したい
    11
    

    View Slide

12. ご清聴ありがとうございました
    

    View Slide

13. おまけ：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
    

    View Slide