Upgrade to Pro
— share decks privately, control downloads, hide ads and more …
Speaker Deck
Features
Speaker Deck
PRO
Sign in
Sign up for free
Search
Search
テキストマイニングを使って 今年1年のレビュー内容をふりかえってみた話
Search
Cybozu
PRO
December 21, 2022
Technology
1
790
テキストマイニングを使って 今年1年のレビュー内容をふりかえってみた話
「LINE Technical Writing Meetup vol. 19 ~ 年納め LT パーティ」発表資料
https://line.connpass.com/event/267692/
Cybozu
PRO
December 21, 2022
Tweet
Share
More Decks by Cybozu
See All by Cybozu
不具合の先にある面白さ~配属3か月目の新卒QAのいま~
cybozuinsideout
PRO
0
33
kintone開発チームの紹介
cybozuinsideout
PRO
1
77k
kintone開発のプラットフォームエンジニアの紹介
cybozuinsideout
PRO
0
140
AIツール開発ワークショップ(Dify)【サイボウズ新人研修2025】
cybozuinsideout
PRO
20
24k
モバイル【サイボウズ新人研修2025】
cybozuinsideout
PRO
3
3.9k
Git/GitHub を使う上で知っておくと嬉しいかも Tips【サイボウズ新人研修2025】
cybozuinsideout
PRO
14
11k
GitHub Copilot活用【サイボウズ新人研修2025】
cybozuinsideout
PRO
15
15k
ソフトウェアライセンス【サイボウズ新人研修2025】
cybozuinsideout
PRO
14
8.5k
エンジニアのためのアウトプット講座 〜知識をシェアするはじめの一歩〜【サイボウズ新人研修2025】
cybozuinsideout
PRO
7
4.8k
Other Decks in Technology
See All in Technology
能登半島地震で見えた災害対応の課題と組織変革の重要性
ditccsugii
0
970
Node.js 2025: What's new and what's next
ruyadorno
0
340
衛星画像超解像化によって実現する2D, 3D空間情報の即時生成と“AI as a Service”/ Real-time generation spatial data enabled_by satellite image super-resolution
lehupa
0
170
スタートアップにおけるこれからの「データ整備」
shomaekawa
2
480
ユーザーの声とAI検証で進める、プロダクトディスカバリー
sansantech
PRO
1
140
Introduction to Sansan Meishi Maker Development Engineer
sansan33
PRO
0
310
Introduction to Sansan for Engineers / エンジニア向け会社紹介
sansan33
PRO
5
43k
React19.2のuseEffectEventを追う
maguroalternative
0
260
Sansan Engineering Unit 紹介資料
sansan33
PRO
1
3k
いまからでも遅くない!SSL/TLS証明書超入門(It's not too late to start! SSL/TLS Certificates: The Absolute Beginner's Guide)
norimuraz
0
240
プロポーザルのコツ ~ Kaigi on Rails 2025 初参加で3名の登壇を実現 ~
naro143
1
250
AWSでAgentic AIを開発するための前提知識の整理
nasuvitz
2
160
Featured
See All Featured
Documentation Writing (for coders)
carmenintech
75
5.1k
Java REST API Framework Comparison - PWX 2021
mraible
34
8.9k
Building an army of robots
kneath
306
46k
Optimising Largest Contentful Paint
csswizardry
37
3.5k
Designing Experiences People Love
moore
142
24k
VelocityConf: Rendering Performance Case Studies
addyosmani
332
24k
Testing 201, or: Great Expectations
jmmastey
45
7.7k
Facilitating Awesome Meetings
lara
56
6.6k
Raft: Consensus for Rubyists
vanstee
140
7.1k
Save Time (by Creating Custom Rails Generators)
garrettdimon
PRO
32
1.6k
Designing for Performance
lara
610
69k
Imperfection Machines: The Place of Print at Facebook
scottboms
269
13k
Transcript
テキストマイニングを使って 今年1年のレビュー内容をふりかえってみた話 サイボウズ株式会社 ぴよ 仲田 尚央
自己紹介 ぴよ(サイボウズ株式会社) _chick_p 今日話す人 🎤 お仕事 サイボウズ製品の UI テキストを書く 製品のヘルプページや開発者向けドキュメントを書く
仲田 尚央(サイボウズ株式会社) naoh_nak ネタを考えた人 💭 お仕事 サイボウズ製品の UI テキストを書く 製品のヘルプページを書く 他の言語に展開する(ローカライズ) 2
今日のおはなし テキストマイニングを使って、今年 1 年で自分が編集した記事へのレビューコメントを分析して、今年をふりかえって みた きっかけ 3
ヘルプサイトにおけるコンテンツの作成フロー サイボウズでは、GitHub でヘルプサイトのコンテンツを管理している 詳細:プロダクトのヘルプサイトをマークダウンに移行した話 | Cybozu Inside Out GitHub Reviewer
Pull Request コメント & 承認 公開 投稿 Writer Web 4
今年の Pull Request のレビューコメントを分析 Pull Request 今年 ⾃分が作った レビュー コメント
⼊⼒ テキストマイニングツール Word Cloud 分析 レビューに関する キーワード TextVoice ふりかえりの対象 今年自分が編集したコンテンツに対する、メンバーからのレビューコメントの内容 やったこと Pull Requestからレビューコメントを取得し、テキストマイニングツールでキーワードを分析 5
分析結果 6
分析結果 - ワードクラウドにしてみた(絞込前) レビューコメントにおけるキーワードの出現頻度から、ワードクラウドを作成 画面文言や製品の機能名がノイズになった レビューに関するキーワードだけに絞り込むことにした 7
分析結果 - ワードクラウドにしてみた(絞込後) レビューに関するキーワードだけに絞り込んで、ワードクラウドを作成 ライティングのテクニックに関するキーワードより、記載した内容に言及するキーワードが目立つ 例:案内、カット など 8
分析結果 - 実際のコメントを紹介 係り受けがわかりにくいと、誤解しやすく翻訳もしづらい文になる ユーザーがつまづきやすいポイントをフォローする 想定読者にあわせて書きすぎない 自社製品ではないブラウザやOSの設定は書かない コンテンツのメンテナンスコストも上がる 2022年は 画像の代替テキストに注力していた
技術支援ツールを使ってヘルプを読むユーザーもいる 1 係り受けを明示して、どんなチェックボックスかを示した方が翻訳しやすそうかなと思いました。 2 この部分も、事前設定でできると勘違いしやすい部分だと思うので、「事前設定では、ユーザー追加はできないんだよ」と案内して おくと良さそうです。 3 Storeで2段階認証を設定する方は、その機能を理解している人だと思うので、L.9はカットしてもよいかなと思いました。 4 VerによってUIが変わったりするでしょうし、画像消しません?弊社以外のサービスはサポート外というのもありますし。 5 この補足のタイトルからどんなエラーメッセージが出るかは明確なので、Altでは簡潔に案内するので良さそうです。 9
まとめ(1/2) やったこと テキストマイニングを使って、今年編集したコンテンツに対するレビュー内容をふりかえってみた ふりかえってみて "テクニカルライティング"といえば、ライティングのテクニックが印象に残りやすいかも 一文一義、係り受け など 実際のレビューは、記載する内容に言及することが多い 何を書くべき/書かないべき 読み手を意識した、内容の取捨選択
ヘルプページに書いてある = サポート対象になる アクセシビリティへの配慮 (再掲)レビューコメントだけに絞込した後のワードクラウド 10
まとめ(2/2) 来年にむけて 読者を考慮して、書くべき/書かないべきの取捨選択をより意識する 来年もふりかえってみて、ワードクラウドのキーワードの変化を確認したい 11
ご清聴ありがとうございました
おまけ: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