「LINE Technical Writing Meetup vol. 19 ~ 年納め LT パーティ」発表資料 https://line.connpass.com/event/267692/
テキストマイニングを使って今年1年のレビュー内容をふりかえってみた話サイボウズ株式会社ぴよ仲田 尚央
View Slide
自己紹介ぴよ(サイボウズ株式会社) _chick_p今日話す人 🎤お仕事サイボウズ製品の UI テキストを書く製品のヘルプページや開発者向けドキュメントを書く仲田 尚央(サイボウズ株式会社) naoh_nakネタを考えた人 💭お仕事サイボウズ製品の UI テキストを書く製品のヘルプページを書く他の言語に展開する(ローカライズ)2
今日のおはなしテキストマイニングを使って、今年 1 年で自分が編集した記事へのレビューコメントを分析して、今年をふりかえってみたきっかけ3
ヘルプサイトにおけるコンテンツの作成フローサイボウズでは、GitHub でヘルプサイトのコンテンツを管理している詳細:プロダクトのヘルプサイトをマークダウンに移行した話 | Cybozu Inside OutGitHubReviewerPull Requestコメント &承認公開投稿WriterWeb4
今年の Pull Request のレビューコメントを分析Pull Request今年 ⾃分が作ったレビューコメント ⼊⼒テキストマイニングツールWord Cloud分析レビューに関するキーワードTextVoiceふりかえりの対象今年自分が編集したコンテンツに対する、メンバーからのレビューコメントの内容やったことPull Requestからレビューコメントを取得し、テキストマイニングツールでキーワードを分析5
分析結果6
分析結果 - ワードクラウドにしてみた(絞込前)レビューコメントにおけるキーワードの出現頻度から、ワードクラウドを作成画面文言や製品の機能名がノイズになったレビューに関するキーワードだけに絞り込むことにした7
分析結果 - ワードクラウドにしてみた(絞込後)レビューに関するキーワードだけに絞り込んで、ワードクラウドを作成ライティングのテクニックに関するキーワードより、記載した内容に言及するキーワードが目立つ例:案内、カット など8
分析結果 - 実際のコメントを紹介係り受けがわかりにくいと、誤解しやすく翻訳もしづらい文になるユーザーがつまづきやすいポイントをフォローする想定読者にあわせて書きすぎない自社製品ではないブラウザやOSの設定は書かない コンテンツのメンテナンスコストも上がる2022年は 画像の代替テキストに注力していた 技術支援ツールを使ってヘルプを読むユーザーもいる1係り受けを明示して、どんなチェックボックスかを示した方が翻訳しやすそうかなと思いました。2この部分も、事前設定でできると勘違いしやすい部分だと思うので、「事前設定では、ユーザー追加はできないんだよ」と案内しておくと良さそうです。3Storeで2段階認証を設定する方は、その機能を理解している人だと思うので、L.9はカットしてもよいかなと思いました。4VerによってUIが変わったりするでしょうし、画像消しません?弊社以外のサービスはサポート外というのもありますし。5この補足のタイトルからどんなエラーメッセージが出るかは明確なので、Altでは簡潔に案内するので良さそうです。9
まとめ(1/2)やったことテキストマイニングを使って、今年編集したコンテンツに対するレビュー内容をふりかえってみたふりかえってみて"テクニカルライティング"といえば、ライティングのテクニックが印象に残りやすいかも一文一義、係り受け など実際のレビューは、記載する内容に言及することが多い何を書くべき/書かないべき読み手を意識した、内容の取捨選択ヘルプページに書いてある = サポート対象になるアクセシビリティへの配慮(再掲)レビューコメントだけに絞込した後のワードクラウド10
まとめ(2/2)来年にむけて読者を考慮して、書くべき/書かないべきの取捨選択をより意識する来年もふりかえってみて、ワードクラウドのキーワードの変化を確認したい11
ご清聴ありがとうございました
おまけ:textlint のチェック結果ルール名 エラー内容 回数jtf-style/4.3.7.山かっこ<> 半角になっている、かっこが閉じられていない 533jtf-style/4.2.6.ハイフン(-) 半角になっている 158jtf-style/4.3.5.二重引用符 対になっている 115jtf-style/2.1.2.漢字 常用漢字じゃない 102jtf-style/4.3.1.丸かっこ() 半角になっている、かっこが閉じられていない 34ja-no-redundant-expression 冗長表現である 15jtf-style/2.1.6.カタカナの長音 長音記号がない 8prh 表記ゆれがある 5@textlint-rule/require-header-id 見出し ID が振られていない 4jtf-style/2.1.5.カタカナ 半角カタカナがある 3jtf-style/4.2.4.中黒(・) 半角の中黒がある 3jtf-style/4.3.3.かぎかっこ「」 全角になっている 1jtf-style/2.2.1.ひらがなと漢字の使い分け ひらがなと漢字の使い分けが適切ではない 113