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
テクニカルライティング
Search
Cybozu
PRO
July 29, 2024
4
300
テクニカルライティング
Cybozu
PRO
July 29, 2024
Tweet
Share
More Decks by Cybozu
See All by Cybozu
サイボウズ 開発本部採用ピッチ / Cybozu Engineer Recruit
cybozuinsideout
PRO
9
45k
サイボウズのアジャイルクオリティ2024
cybozuinsideout
PRO
3
260
モブに早く慣れたい人のためのガイド2024
cybozuinsideout
PRO
3
360
モバイル
cybozuinsideout
PRO
3
180
ソフトウェアライセンス
cybozuinsideout
PRO
4
160
ソフトウェアテスト
cybozuinsideout
PRO
3
260
自動テスト
cybozuinsideout
PRO
3
270
Docker入門2024
cybozuinsideout
PRO
3
450
kubernetes入門
cybozuinsideout
PRO
5
410
Featured
See All Featured
Statistics for Hackers
jakevdp
796
220k
StorybookのUI Testing Handbookを読んだ
zakiyama
27
5.3k
The World Runs on Bad Software
bkeepers
PRO
65
11k
How to Think Like a Performance Engineer
csswizardry
20
1.1k
Responsive Adventures: Dirty Tricks From The Dark Corners of Front-End
smashingmag
250
21k
Writing Fast Ruby
sferik
627
61k
Why Our Code Smells
bkeepers
PRO
334
57k
Scaling GitHub
holman
458
140k
Ruby is Unlike a Banana
tanoku
97
11k
Building Better People: How to give real-time feedback that sticks.
wjessup
364
19k
Designing the Hi-DPI Web
ddemaree
280
34k
Optimizing for Happiness
mojombo
376
70k
Transcript
開運研修 テクニカルライティング
⾃⼰紹介 ▌⼩林智⼦ l 2020年1⽉サイボウズ キャリア⼊社 l 前職はマニュアル制作・翻訳会社 l ライティング、プロジェクトマネジメント、 翻訳ディレクション、ライター育成
l 開発本部のテクニカルライター職能のマネージャー
テクニカルライターの仕事 ▌サイボウズでは、製品の画⾯⽂⾔やヘルプのライティングを担当 ▌テクニカルライターとは、 「テクニカルライティング」という⼿法で技術 的な情報を分かりやすく伝える仕事 ▌テクニカルライターの仕事で⼤事なこと l ⾔葉を通じて、読み⼿の認知にどう影響を与えるかを判断すること
わかりやすい⽂章のためのテクニック ▌世の中に「わかりやすい⽂章の書き⽅」の情報があふれている l 「⽂章でどう表現するか」というテクニックの話が多い l 例(参考︓2023年開運研修「テクニカルライティング」の資料) l ⼀⽂⼀義で書く l 短く、簡潔に書く
l 肯定系で書く l 受動態と能動態を使い分けて書く
わかりやすい⽂章のための2つのこと ▌ライティングのテクニックだけでは、わかりやすい⽂章にはならない ▌「⽂章でどう表現するか」と「何を伝えるか」のどちらも⼤事 ▌「何を伝えるか」のためにできること l そもそも読み⼿はどのように⽂章を理解するのかを知る l ⽂章という情報をインプットすると、どう処理されるのかを知る
⽂章はどう読まれるのか 6
右に左にいったり、上に下にいったりする。 まっすぐ合わせるだけでなく、⾓度をつける。 強すぎず、弱すぎず。 できないところは別のものを使うとよい。 7
タイトル 「⻭磨きについて」 右に左にいったり、上に下にいったりする。 まっすぐ合わせるだけでなく、⾓度をつける。 強すぎず、弱すぎず。 できないところは別のものを使うとよい。 8
読み⼿が⽂章をどう理解するか ▌⽂章から「インプットされた情報」と、読み⼿の「すでに持っている 知識やイメージ」が結びつくと、⽂章に書いていないことも頭の中 で補完してくれる ▌読み⼿の「すでに持っている知識やイメージ」=「メンタルモデル」 l 認知⼼理学の⾔葉の⼀つで、⼈が何かものごとや⼈などに対して 持っているイメージのこと
読み⼿のなかで情報がどう処理されているか 情報 この情報といえば こういうものだな 関連情報は このあたりかな 最初の情報 次の情報 想像していた情報⇒ 理解
想像していた情報ではない ⇒ メンタルモデルの 作り直し
読み⼿のなかで情報がどう処理されているか 情報 ⻭を磨く動作や 使うもの ⻭磨きの⽅法︖ ⻭ブラシの選び⽅︖ グラス・⽔・ ⻭磨き粉︖ 最初の情報 次の情報
⻭磨きの⽅法だ︕ ⽂章のタイトル 「⻭磨きについて」 右に左にいったり…
メンタルモデルに合わせて情報展開する ▌わかりやすい⽂章とは、読み⼿の情報処理のスピードを落とさな い、情報処理を⽌めない⽂章のこと ▌読み⼿のメンタルモデルと合わない情報を提供すると、処理ス ピードが低速になり、メンタルモデルを作り直すことに ▌メンタルモデルに合わせた情報展開とは l メンタルモデルを作りやすいような情報構成 l 作ったメンタルモデルと関連する情報を提供する
⽂章でどう伝えるか 13
情報をインプットする順番に気を付ける ▌「知っていること」から「知らないこと」へ ▌「全体のこと」から「詳細のこと」へ ▌「⼤事なこと」から「知っておいたほうがいいこと」へ
メンタルモデルを崩さない情報を提供する ▌視点を変えない ▌関係ない話をしない ▌複数の意味にとれる表現にしない
まとめ 16
読み⼿のことを考えて書こう ▌「読み⼿のことを考えて書く」とは、読み⼿のメンタルモデルを推測 すること l 読み⼿が今どういう情報を持っているか l 読み⼿が今どういうことを連想しているか l 新しい情報を提供すると、読み⼿が次に連想 する情報にどういう影響を与えるか
サイボウズのテクニカルライターが ⼤事にしていること 18
ユーザーへの価値提供の最⼤化 ▌画⾯⽂⾔やヘルプも製品の価値を向上させる⼤事な部分 l ライターという専⾨職能として、チームや製品にとって必要なことは なにか、ユーザーにどのような価値を提供できるか ▌ライティングだけではなく、開発プロセス改善にもチャレンジ l ライターも製品開発チームのメンバー l 開発スピードに追随できるように、開発前からの⽂⾔検討や⽂⾔
品質の切り分け(kintone開発)