仲田尚央『エンジニアが一生困らない ドキュメント作成の基本』予約受付中
@naoh_nak
Followers
923
Following
274
Media
102
Statuses
1,828
UXライター、テクニカルライター @SmartHR ex. Cybozu テクニカルライティング講師@都立産業技術高専 著書：『ヘルプサイトの作り方』『エンジニアが一生困らない ドキュメント作成の基本』
Joined February 2019
Don't wanna be here?
Send us removal request.
Explore trending content on Musk Viewer
FEMA
• 1203388 Tweets
Liz Cheney
• 209584 Tweets
#LISAxMoonlitFloor
• 197221 Tweets
MOONLIT FLOOR OUT NOW
• 137932 Tweets
SCJN
• 128619 Tweets
The Boss
• 103770 Tweets
#GHGala5
• 100032 Tweets
Bruce
• 92338 Tweets
Mets
• 69981 Tweets
Happy Anniversary
• 59797 Tweets
Baker
• 51010 Tweets
Brewers
• 42600 Tweets
EL DESTELLO IS OUT
• 34794 Tweets
天使の日
• 33230 Tweets
Falcons
• 29013 Tweets
Mancuso
• 25832 Tweets
Halle
• 24850 Tweets
もちづきさん
• 24728 Tweets
Pete Alonso
• 19614 Tweets
Athena
• 15232 Tweets
Mike Evans
• 14530 Tweets
Bijan
• 13510 Tweets
Phillies
• 11404 Tweets
#ゴンチャのハロウィン準備中
• 10748 Tweets
Milwaukee
• 10479 Tweets
Quintana
• 10036 Tweets
Pinned Tweet
ドキュメントの書き方を学ぶサイボウズの研修資料「テクニカルライティングの基本」の2023年版。
録画もエンジニアブログのほうで後日公開されると思います。
昨年版と比べて、「文章の骨組みを作る」ところに重点を置いています。情報を整理して伝えることが何より大事。
1
123
708
サイボウズの新入社員向けに実施した、「テクニカルライティングの基本」講座の資料をアップしています。
情報の構造化と、読みやすい文章について、ここだけは押さえておくと良いよ！というポイントをまとめています。
後日Cybozu Inside Outで動画も公開されると思います。
0
139
581
本を書きました『エンジニアが一生困らない ドキュメント作成の基本』9月19日に発売予定です！
仕様書、報告書、マニュアルなどプロダクト開発に必要なドキュメントを書く機会のある方向けに、情報をどう整理してドキュメントの構成や文章に落とし込むかをまとめています。
4
45
283
そうなんです。わかっておられる（誰目線）。
テクニカルライティングは応用範囲が広いので、エンジニアに限らず仕事の基礎スキルだと思っています。
> 特にテクニカルライティングの資料は全社会人が読むべき内容です。
0
17
171
今日が16年勤めたサイボウズへの最終出社でした。辞めた身ではありますが、本当にいい会社でした！
5月から別のところでお仕事します。
ひとまず飲む！🍺
5
2
161
「すべてのテキストは読まれないことを前提に書く」はテクニカルライティングと通ずるところだな。
そして、プロダクトのVoice&Toneに合わせたライティング、UXや顧客のゴールへのコミットはテクニカルライターが学ぶところ。「情報を正しく伝える」以上を要求される。
UXライティングについて判りやすくまとまってる。
- オンラインでは読むスピードが25%低下する
- オンラインでは20−28%程度の文字しか読まれない
これを踏まえてUXライティングは
・明瞭さ
・簡潔さ
・一貫性
を実現する。
How UX writing can help create good design
1
94
583
1
21
118
拙書が発売前にして重版が決まったとの連絡を受けました。もう何も思い残すことはない...（早
本書をご予約いただいた方々、ご紹介いただいた方々には感謝の気持ちでいっぱいです。
本書がエンジニアのドキュメント作成や情報発信の一助になればと願っております！
3
29
96
マイクロソフトから学ぶUXライティングの話。英語だけれど、例が豊富。
- バリューから始めよ
- 丁寧さより簡潔さを重んぜよ
- エラーメッセージには正しい操作の例を出せ
- 1パラグラフを短く（3～7行）
- 「クリック/タップ」ではなく「選ぶ」
など
1
10
73
見本誌を手に入れた。思ったより分厚い！！立てても安定感ある。別の意味で武器になりそう。
やはり本は紙がいい。
0
4
44
『和訳と英訳の両面から学ぶテクニカルライティング』読んでるけれど、すごく良い。日本語と英語の比較を通じて、両言語の理解を深めていく。
情報量多いので、深く学びたい人向け（あるいは、書くことを仕事にしている人向け）かな。
翻訳される文章を書く人には特に良さそう。
2
4
38
4月は新年度の始まり！🌸 ということで、Software Design4月号では、「今から始めるテクニカルライティング」特集が組まれるようです。
サイボウズのテクニカルライター3人が寄稿（私自身は裏方です）。開発現場でドキュメントを書く機会のある方はぜひお読みくださいー。
0
9
31
マネージャー「何か困ってることありますか？」
メンバー「いや、特に」→終了
↓
マネージャー「最近○○○に悩んでて...」
メンバー「わかります。私も○○○が気になっていて～」
名前を聞く前にまず自分から名乗れ、みたいな話。人の話を聞くのが上手な人から学んだ。
0
3
29
リブセンスさんのエンジニアの方々と、テクニカルライティング勉強会！
盛況さからも、いただいた質問からも、どう書けば技術がうまく伝わるか、皆さん模索されている姿勢を感じました。テクニカルライターの一人として、そのような姿勢がとても嬉しいです。
仲田尚央さん(
@naoh_nak
)に講師をお願いし、テクニカルライティング勉強会を開催しました。
大盛況となった勉強会のレポート記事をぜひご覧ください。
テクニカルライティングで技術をわかりやすく伝えよう！テクニカルライティング勉強会開催記 - LIVESENSE ENGINEER BLOG
0
5
15
0
9
27
FAQにフォーカスした本が出るらしい。出版社のご厚意で贈っていただいて、朝から読み込んでました。
QとAの良い書き方、FAQの分析と更新、システム選定まで網羅されていて、良い本！
FAQをこれから作ろうというとき、今あるFAQを改善したいときに読むと良さそうです。
1
10
26
『ザ・ダークパターン ユーザーの心や行動をあざむくデザイン』読みました。
これは、サイトやデジタルプロダクトのデザインに関わる人に向けた「倫理」の教科書だな。
言葉の設計に関わるUXライターは、自身の学びとしても、倫理違反を防ぐ説得材料としても、本書で出ている裏付けデータが使えそう。
0
6
26
昨晩は、テクニカルライティングを学ぶと食レポや書評も書けちゃうよという話をしました（ほんまかいな）
0
8
24
翻訳会社の単価は、翻訳品質はもちろんだけど、翻訳者との橋渡しをしてくれるコーディネーターのスキルにも如実に反映される印象。
お高めなところはやはりコーディネーターの能力も高くて、コミュニケーションがとてもスムーズに進む。
1
10
23
職場のチームメイトが描いてくれた。嬉しい！ほどよい脱力感があるw
いろんなところで使っていこう。
2
0
22
今年も入れて貰えました。ありがたい🙏
テクニカルライティングは一般教養だと思っています。わかりやすく人に伝えるスキルはどの職業でも大事。
🎉 2023 年に最も閲覧されたデッキ 25 選! 👇
おめでとう：
@e869120
,
@tumada
,
@mixi_engineers
,
@mtx2s
,
@yutadayo
,
@hiro_gamo
,
@dahatake
,
@iwashi86
,
@naoh_nak
,
@RosaRugosaBeach
,
@doradora09
,
@konifar
0
40
135
1
4
22
製品ヘルプページのキーボード操作について、アクセシビリティーチームから「かなりよく出来ていますね！」との言葉をいただいた。
ナビゲーションツリーとか相当頑張っているので、是非キーボードで使って見て欲しい！
0
6
21
都立産技高専で受け持っている「テクニカルリーディング・ライティング」の半期授業が今日から開始。
自分が学生の頃は学校でドキュメントの書き方を学ぶ機会なんて無かったので、こういう授業が始まるのはスバラシイな。
緊張して写真撮り忘れた。
0
0
21
デブサミの「技術をわかりやすく伝えるためのテクニカルライティング」セッションでベストスピーカー賞5位をいただきました🎉
録画も配信されているようです。テクニカルドキュメントの書き方を40分で学べます。
つよつよエンジニアさんたちに交じっただけで大満足なのに、ありがたい🙏
0
0
20
サイボウズのテクニカルライター/UXライターと話してみませんか？
メンバーがMeety始めました。
私も始めてみるつもり。
【キャリア採用】
ユーザーが快適にプロダクトを利用するためには、プロダクトのUI文言の作成やヘルプページの制作が必須となります。サイボウズのテクニカルライターのメンバーがMeetyをはじめましたので、興味ある方ぜひお声がけください！
#エンジニア採用
#Meety
0
4
15
0
6
19
これはテクニカルライターが書いちゃいけない説明。
溶かす前のラードを熱湯に投入した…
0
3
19
『日本語スタイルガイド』を出しているTC協会が「伝える」をテーマに開催する年イチイベント「CDシンポジウム」が8月27日〜29日で開催。
私は、FAQの専門家、行動観察の専門家の方と、「ユーザー理解」を深堀りするパネルディスカッションを担当します。楽しみ。
1
5
18
サイボウズでも、各ヘルプページに「記事番号」を振ってる。この記事番号をURLに入れると、該当ページに移動する。
例：
パーマリンクとしての機能に加えて、サポート電話窓口がヘルプページを案内する際に「番号040449のページをご覧ください」と案内できるメリットもある。
サイト内で各ページにユニークな番号を振る流儀もある。三重県内の自治体について石田先生の調査↓ 例えば四日市市はトップ以外のページに「問い合わせ番号」が振ってある
0
39
73
0
8
19
年末の「LINE Technical Writing Meetup vol. 19 ~ 年納め LT パーティ」の資料をアップ。
今回は書籍『THE PRODUCT IS DOCS』の紹介でした。製品開発組織の中でのドキュメントチームにフォーカスした貴重な本。
0
2
18
マニュアル書いてるとプロダクトのわかりづらさに気付くし、UIの文言を少し変えるだけマニュアルでの説明が大きく減ることもよくある。
UI文言とマニュアルは、ライティングに必要なスキルが違うけれど、やはり同じチームでやる効果は大きい気がしてる。
0
1
18
ご紹介ありがとうございます！
ドキュメントを設計し文章にまで落とし組むところにフォーカスした書籍で、ドキュメントをプロダクトとして見て運用していくプロセスを解説した『エンジニアのためのドキュメントライティング』と合わせて参照いただけると良いと思っています。
0
1
18
研修資料、多くの人に見て貰えてありがたい。テクニカルライティングは、テクニカルライターに限らずあらゆる職種で持つべき必須素養だと思ってます。
0
1
18
遅くなりましたが、当日の資料を公開します。アジャイル開発の中での翻訳プロセス、製品ドキュメントへの機械翻訳適用の話など。
JTF翻訳祭2019で発表しました - Cybozu Inside Out | サイボウズエンジニアのブログ
0
6
17
サイボウズ製品のUIやドキュメントのローカライズにご協力いただける日英翻訳者を募集開始です。働く場所や勤務時間は相談可です！週4日は在宅勤務にしたり、週休3日にしたりなど、みんな柔軟に仕事しています。もちろんフルタイムも歓迎。
0
18
17
エスカレーター降りたら拙書がどどーんとお出迎えという@ジュンク堂池袋本店
特等席過ぎんか。こんなことあっていいのか。。
2
1
16
サイボウズのエンジニア新人研修の資料が、今年も公開されました！
先日公開した『テクニカルライティングの基本』講座の録画もあります。いや、資料だけでも内容を掴めるはずなんですけどね（ライティングの講座だけに）
0
3
16
今期から学校で授業を持たせて頂くことに。今日は講師向けの説明会。ちょうど桜🌸が満開だ。
何でもやってみるもの、とは思ってるけど、果たして90分×15回も話題が持つか...？？
0
0
16
ご恵贈いただきました：『良いFAQの育て方』
前作の『良いFAQの書き方』に対して、今回は継続的な運用がテーマ。「スモールスタート」というアジャイルの考え方に則った内容で良さそう。
PDCAサイクルに加えて、コスト対効果の算出や、運用体制の話も。
書店での販売は明日。
0
6
16
良いFAQの書き方や運用を学びましょう！
UX×テクニカルライティング勉強会、第5回はFAQをテーマにしました。
FAQに関する著者、大矢さんと樋口さんにお話いたただきます（豪華！）。
無料（お得！）ですのでお気軽にご参加をー！
わいわい楽しく学びましょう。
0
3
16
お、この本良かったです！
以前原本を読んだ感想：
後半のほうが、より具体的で実践的な話で面白い。
邦訳が出るんですね。また読みたい。
【新刊情報】4月26日(火)オライリー・ジャパンより、『戦略的UXライティング 言葉でユーザーと組織をゴールへ導く』が発売される模様です。著者はGoogleのUXライターTorrey Podmajerskyさん。Amazonでも予約が始まっていました。
0
17
72
0
4
16
テクニカルライティングのスキルはブログにも役立つ！
勉強会講師としてお手伝いさせていただきました。記事増に少しでも貢献できていたらウレシイです。
雰囲気作り、執筆のサポートなど、リブセンスさんのエンジニア採用広報チームの手厚さすごい。
1
1
16
有り難いことにライティング講習の依頼をたまに戴くようになった。
ただ、講習参加者の熱心さや質問の深さに圧倒されてしまい、下手なことを言っては申し訳ないと今さらながら文章作法関連の本を読み漁っている。
どの本を読んでも学びがあるので、書くことって奥深い。
0
0
15
半年続いた「テクニカルリーディング・ライティング」の授業もようやく今日で終わり。ここ数日はずっと採点に掛かり切りだった。。
1
0
15
デブサミで頂いた感想のうち面白かったのは、テクニカルライティングの考え方が「読みやすいソースコードと同じ」というもの。
そうなのか。
プログラマーとしてはぺーぺーな私が、いつの間にか達人プログラマー的思考を身に着けていた（たぶん身に着いてない）。
3
0
15
社内でドキュメントのユーザビリティーテストを実施。
「ユーザーは単語だけを拾って読む」を実感させられるな。
文章を丁寧に書いても、語の選定を誤ると、そもそも読んで貰えない。
0
1
15
「文書の書き方」を教えようとすると「論理的な考え方」から始めなければならないの、学校でライティングを教えている身としてめっちゃわかる。
文章の問題は、頭の中で論理がまとまっていないことが表層に現れたものにすぎないという。
1
1
15
ドキュメントの効果測定の話。面白い。
読みやすさみたいな「ドキュメントとしての品質」だけでなく、「ドキュメントの存在目的を果たせているか（目的を達成するまでの時間、問い合わせの減少数あたり？）」を測ることも大事だな。
1
1
14
チームメンバーが書きました。
毎日チームで動画を見る活動を1年間続けてみたら、予想以上にいい効果がありました。良かった動画と共に紹介します！（動画の紹介はPart2以降）
0
2
15
UXライティングの教科書、ようやく読み終えた。これはいい本。タイトルどおり教科書的にそばに置いておきたい。
strategic writing for UXと良い感じに内容が被らないので、補完的に両方読むと良さそう。
0
6
15
放送大学の「日本語を書こう」の授業がすごく面白い。論文を書く文章力を身に着ける授業。日本語の成り立ちから解説があり、雑学としても面白い。
- ひらがなは詩（うた）を詠むために作られた
- カタカナはお寺で中国語を読むための補助記号として作られた
とか。へぇぇー。
1
1
14
社内でテクニカルライティング勉強会を実施。参加者からの評価も上々で良かった！
が、少し雰囲気硬いなーと自分で感じてしまう。資料の完成度はまぁまぁ高いはずだし、言いたいことは伝わってる...ん？その症状ってどこかで聞いたことある。あ、テクニカルライティングで書かれた文書だ（オチ）
1
0
14
読んでる。
"GoogleとMicrosoftでは、タイトルや見出しに「センテンス・スタイル」を用いるとしています。一方、Red Hatでは「タイトル・スタイル」としています。" のように、複数のスタイルガイドを横断したリファレンスになっているのがありがたい。
1
5
14
マニュアルで良く使う「このページでは～を説明します。」「～を紹介します。」って、書き手視点だよなぁ、と改めて思った。
「～の情報を得られます。」「～を学べます。」のほうが、読み手視点。
0
0
14
テクニカルライティングミートアップでの資料はこちらにアップしました。
モチベーション3点セットで考える 読者のモチベーションを⾼める技術
0
0
14
第二子が産まれ、短い育休をいただいてました。今日から仕事復帰。
コロナにより、出産の立ち会いは禁止。産後に子供の写真を渡されるだけという。薬を使えない妊婦さんがいるので仕方ない。
0
0
13
近所の小さめな本屋にも並んでる！発売されたんだなーと実感。
「一生困らない」という強めなタイトルで震えますが、編集者さんには太鼓判を押して貰っています。
気になった方は是非お手に取ってみてください！
0
2
14
テクニカルライティングでは（読みやすさを重視して）敬語不要を旨とするけれど、お金の話になると急に表現が丁寧になりがち。
1
1
13
"どんなにがんばっても、長いチュートリアル、さらにいえば手順的なコンテンツを少ない手順に凝縮できないならば、サービスそれ自体が複雑すぎるかもしれません"
わかる。ドキュメント書いてると、プロダクトの複雑さに気付くこと多い。手順の数から、操作の複雑さが視覚化される。
2
2
13
8月24日～8月26日に、コミュニケーションデザインシンポジウムが開催。
テクニカルライティングの教本『日本語スタイルガイド』を出すTC協会のイベントです。
1
3
13
翻訳の文脈も入れたテクニカルライティング講座って難しいな？？と悩んでいたけれど、ようやくまとまってきました。
今週末（土曜）19時〜です！ご興味のある方はぜひ。
0
6
13
SmartHRさんのUXライティンググループのミッション「言葉の力でプロダクトを、もっとわかりやすく」
「エンゲージメントを高める」とかではなく、「わかりやすく」と、方向性を明示しているのがいいな。
1
0
13
UXライティングを勉強中のテクニカルライターで集まって勉強していこう！という企画があるのだけど、どれくらい来て貰えるんだろう。
毎回2人程度UXライティングをテーマにプレゼンするイメージでいます。スピーカーも募集。
初回はHCDの方と弊社ライターによるプレゼンになりそう。
1
0
13
休暇を貰って伊豆へ。ログハウスって不思議と落ち着く。明日は河津桜を観に行くけれど、天気が微妙…
1
0
13
文章のライティングとプログラミングって、学びかたが似てるよね。ひたすら書いて、詳しい人に赤入れしてもらう。良い書き方の方法論を学ぶ。良いとされる文章（プログラム）を読む。写経もすると、さらに良い。
という話を社内でしたところ、共感する人多いようだった。
0
1
12
指摘されないことのほうがはるかに損失が大きい。たしかに。
この姿勢を全員が持つと強い組織になりそう。
フィードバックされやすい人になろう
0
3
12
『ITエンジニアのための英語ライティング』が届いたので読んでる。
生成AIを活用するためのプロンプトを、日本語から翻訳する場合、自分が書いた英語を添削する場合、0から生成させる場合の3つに分けて解説。出力結果のチェックに必要な英語の知識から説明されていて勉強になる。
1
3
11
今読んでる本に、「ユーザーと直接会話しろ。コミュニティとかイベントとかいろいろ手段あるから。企業のテクニカルライターは社内に籠もりがちなんだよ。それだとライターの自己満足に陥るから！」みたいなことが所々に書かれていて、心にグサグサときている。
0
1
12
公開しました！
オンラインなので、どこからでも参加できます。
テクニカルライターの皆さん、UXライティングを一緒に勉強していきましょうー
【オンライン】UX思考で変わるテクニカルライティング勉強会
#1
- connpass
0
2
12
翻訳会社に提示された金額があまりに安すぎると不安になるな。。
amazonで安すぎる商品見るのと同じ気持ち。
1
1
12
UIテキストやマニュアルを書くときはターゲットユーザーを設定するけれど、プロダクトが長く続くとターゲットの層が変わってくる。想定されるITリテラシーも変わってくる（たいてい低まる）。変わると、書き直しに近いことが必要になる。そしてその頃にはプロダクトが大規模になっているからやっかい。
0
0
12
最近子育て本をいろいろ読んでたのだけど、仕��に活きそうな学びも意外と多かったので、書きました。
子育てからの学びは多い！
子育て本に学ぶマネジメント術
0
1
12
先日のWrite the docsカンファレンスであった、AWSドキュメントチームのプレゼンをようやく観た。
Wordで作ってたAWSドキュメントをDocs as code（Asciidocで書いてGitHubで管理）に移行したメリットと、その後出た問題、それをどう解決したか、という話。
1
2
12
マネージャーがすべきは、雄弁に語ることではない。やるべきは、聴くこと、文化と仕組みを作ること、みたいなことをドヤ顔で雄弁に語った。
0
0
11
チームメンバーがブログ書きました！
・ユーザー向け機能解説動画で解決したかった課題（←これが今回の記事のテーマ）
・それをユーザーにどう届けるか（デリバリー）
・実際に動画は役に立ったのか（効果検証）
という話。
1
2
10
経理からテクニカルライター（兼UXライター）という異色？の異動が達成された。いろんなキャリアがあるなー面白い。
1
0
11
朝イチで病院へ。
- 足の骨折がほぼ完治。やったね😃
- 今度は手指を骨折 。全治3週間とのこと😨
もう、厄年終わるまで家に引き篭もっていたい。
7
1
11
LINEさん主催のテクニカルライターミートアップに出させていただきます。
モノや概念を説明するために、テクニカルライターがどう情報を整理して、構造化しているかを話す予定です！
次回のセッションは、矢崎さん
@yazakimakoto
の「区別できるタイトルを付ける」と、サイボウズ 仲田さん
@naoh_nak
の「テクニカルライティングに学ぶ モノや概念をわかりやすく伝えるテクニック」を予定しています。
LINE Technical Writing Meetup vol. 4
#LINE_TWM
0
3
7
0
2
11
休園対応のため今日は午前休。子供を連れて寒空の中、震えながらかき氷を食べている。。子供に言わせると今日は暑いらしい。
1
1
11
コンテンツ戦略とUXライティングって似た文脈で語られることが多いけれど、両者の違いが補完関係の形で整理されてて良かった。組織設計の参考になりそう。
1
2
11
問い合わせが減ることはテクニカルライターが入る効果だけど、それだけだと開発チームにいる理由は無いんだよな。やはりプロダクトの方針との連動だったりプロダクトへのフィードバックに重きを置きたい。
1
1
11
週末に子供の学童のキャンプ合宿を終えて思うのは、キャンプというのは親への負担が尋常じゃないんだなということ。
火起こし、食事作り、後片付け、子供の安全サポート、沢登り、魚の放流、熱中症防止のための水運び。ようやく夜を迎えれば、親同士の懇親会。
自分の親に改めて感謝した週末だった。
0
1
12
観てた。デザインとライティングの密接な関係の話で、だからこそUXライターのジョブディスクリプションではデザイナーやPMとの連動が強調されることが多い。
両方できるデザイナーはつよつよでしょうね。参考書籍やTipsも紹介されてる。
コピーライティング駆動のデザイン
0
2
11
freeeさんでもテクニカルライター的なポジションの募集が始まってる。タイトルは「顧客体験企画」。
ヘルプ/マニュアルはモノ（手段）でしかなく、それを使った（ユーザーと企業双方の）課題解決に責任を持つべき、という思想を感じて、共感する。
0
1
11
年納めは、まさかの骨折。。子供抱えてて、階段踏み外してしまった。来年は良い年になりますよう。
10
0
10
開発に関わる自分が言うのもなんだけど、SlackのUXライティングに関する記事など見ていると、サイボウズ製品で使われる言葉にはイケてる感はないよなぁと思う。
けれど、多少言葉が多くなっても、初心者にもわかるよう、平易な言葉を尽くして画面やドキュメントに書き込んでいる。
1
0
11
明日はテクニカルライターのミートアップ！
今回はヘルプセンターの開発だったりBotの開発だったりと、技術的な話が多そう。
テクニカルライターの仕事は幅広い。
0
3
11