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
760
テキストマイニングを使って 今年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
PSIRTでAIテストを実施するまでの道のり
cybozuinsideout
PRO
0
90
無理なく続けるサイボウズの社内勉強会
cybozuinsideout
PRO
1
1.2k
分散システムにおける 無兆候データ破損の影響について
cybozuinsideout
PRO
1
62
タンパク質構造のシミュレーションソフトウェア試行錯誤
cybozuinsideout
PRO
1
49
読みやすいアセンブリ言語
cybozuinsideout
PRO
1
44
Wasmで拡張できる軽量マークアップ⾔語Brack(後編)
cybozuinsideout
PRO
1
38
Wasmで拡張できる軽量マークアップ⾔語Brack(前編)
cybozuinsideout
PRO
1
39
kintone開発組織のAWSエンジニアの紹介
cybozuinsideout
PRO
0
240
kintone開発組織のサービスプラットフォームチームの紹介
cybozuinsideout
PRO
0
140
Other Decks in Technology
See All in Technology
第9回情シス転職ミートアップ_テックタッチ株式会社
forester3003
0
260
Wasm元年
askua
0
150
CursorによるPMO業務の代替 / Automating PMO Tasks with Cursor
motoyoshi_kakaku
0
370
変化する開発、進化する体系時代に適応するソフトウェアエンジニアの知識と考え方(JaSST'25 Kansai)
mizunori
1
230
Github Copilot エージェントモードで試してみた
ochtum
0
110
250627 関西Ruby会議08 前夜祭 RejectKaigi「DJ on Ruby Ver.0.1」
msykd
PRO
2
330
SalesforceArchitectGroupOsaka#20_CNX'25_Report
atomica7sei
0
200
rubygem開発で鍛える設計力
joker1007
2
220
Amazon Bedrockで実現する 新たな学習体験
kzkmaeda
2
610
本が全く読めなかった過去の自分へ
genshun9
0
590
BrainPadプログラミングコンテスト記念LT会2025_社内イベント&問題解説
brainpadpr
1
170
20250625 Snowflake Summit 2025活用事例 レポート / Nowcast Snowflake Summit 2025 Case Study Report
kkuv
1
330
Featured
See All Featured
Scaling GitHub
holman
459
140k
Cheating the UX When There Is Nothing More to Optimize - PixelPioneers
stephaniewalter
281
13k
Bootstrapping a Software Product
garrettdimon
PRO
307
110k
個人開発の失敗を避けるイケてる考え方 / tips for indie hackers
panda_program
107
19k
Become a Pro
speakerdeck
PRO
28
5.4k
Principles of Awesome APIs and How to Build Them.
keavy
126
17k
Stop Working from a Prison Cell
hatefulcrawdad
270
20k
Statistics for Hackers
jakevdp
799
220k
Building Better People: How to give real-time feedback that sticks.
wjessup
367
19k
Typedesign – Prime Four
hannesfritz
42
2.7k
VelocityConf: Rendering Performance Case Studies
addyosmani
331
24k
We Have a Design System, Now What?
morganepeng
53
7.7k
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