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
590
テキストマイニングを使って 今年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
Recruitment Pitch in New Business Division
cybozuinsideout
PRO
0
12
サイボウズ Office/メールワイズチームの改善の取り組み「困りごと共有会」
cybozuinsideout
PRO
1
16
サイボウズのOSPO
cybozuinsideout
PRO
1
91
非エンジニアの私が試行錯誤の末見出したスクラムマスターの道
cybozuinsideout
PRO
2
130
Kubernetes でもJava アプリでTLS 接続を終端したい
cybozuinsideout
PRO
2
150
Google I/O - 2024 What’s new in flutter
cybozuinsideout
PRO
2
260
Waffle Festival2024(斉藤裕希)
cybozuinsideout
PRO
3
560
主体的な活動で巨大な影響範囲のテストを乗りこなしていく話
cybozuinsideout
PRO
2
360
サイボウズ 開発本部採用ピッチ / Cybozu Engineer Recruit
cybozuinsideout
PRO
9
40k
Other Decks in Technology
See All in Technology
AIエージェントを現場に導入する目線とは
masahiro_nishimi
1
1.5k
Scaling Technical Excellence at 104: Evolution in AWS and Developer Empowerment
scotthsieh825
1
150
GoとアクターモデルでES+CQRSを実践! / proto_actor_es_cqrs
ytake
1
150
公共領域から学ぶ クラウド移行についてエンジニアが意識していること
kawakawa2222
0
140
How to Think Like a Performance Engineer
csswizardry
4
590
AWSサービスメニュー開発をしていてAWSを好きだ!と感じた瞬間
toru_kubota
0
130
Github Actions 로 Android 팀의 효율성 극대화
hadonghyun
0
160
AIアシスタントの活用で品質の向上と開発ワークフローのスピードアップ
nagix
1
190
CEL(Common Expression Language)で書いた条件にマッチしたIAM Policyを見つける / iam-policy-finder
fujiwara3
0
710
データ分析基盤を作ってみよう~設計編~
nrinetcom
PRO
1
110
What if...? 처음부터 다시 LLM 어플리케이션을 개발한다면
huffon
0
1k
さらに高品質・高速化を目指すAI時代のテスト設計支援と、めざす先 / AI Test Lab vol.1
shift_evolve
0
190
Featured
See All Featured
StorybookのUI Testing Handbookを読んだ
zakiyama
15
4.9k
Reflections from 52 weeks, 52 projects
jeffersonlam
346
19k
No one is an island. Learnings from fostering a developers community.
thoeni
17
2.8k
Designing for Performance
lara
604
67k
The Cult of Friendly URLs
andyhume
75
5.9k
Designing with Data
zakiwarfel
96
5k
Code Reviewing Like a Champion
maltzj
517
39k
From Idea to $5000 a Month in 5 Months
shpigford
377
46k
[RailsConf 2023 Opening Keynote] The Magic of Rails
eileencodes
17
8.7k
Building Better People: How to give real-time feedback that sticks.
wjessup
357
18k
How GitHub Uses GitHub to Build GitHub
holman
471
290k
Learning to Love Humans: Emotional Interface Design
aarron
269
39k
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