伝わるドキュメントの作成ノウハウ大公開！！ #DevReljp # 76 公式ツイートまとめ
-
beajourneyman
- 3378
- 18
- 0
- 0
-
- いいね！0
近藤佑子
@kondoyuko
テクニカルライティングとは、ユーザビリティの高い文章、なるほど…（自分の知ってることもユーザビリティという観点でまとめてみたい） #DevReljp
2022-07-06 19:49:56
じゅん@4/17XRMTG北海道エリアのお世話 5/18VRCミートアップ 9/28💉7
@jun_mh4g
#DevRelJP テクニカルライティングの要素をまとめた図 →ユーザビリティの高いドキュメントを目指そう いいドキュメントにするための施策のあれこれ これから細かい内容の説明へ。 pic.twitter.com/iCajkvZnEM
2022-07-06 19:50:11
拡大
拡大
Atsushi@MOONGIFT
@goofmint
概要から具体へ 全体から部分へ #DevRel #DevReljp pic.twitter.com/MO71JCVrXJ
2022-07-06 19:51:10
拡大
職業「戸倉彩」👩💻 Women in Data Science Ambassador
@ayatokura
テクニカルライティングの要素 ✅ Effectiveness (必要な情報を正しく得られる) ✅ Efficiency (効率よく理解できる) ✅ Satisfaction (不快さがなく、肯定的に受け止められる) → すなわちユーザビリティの高いアウトプットであることが大切💡 #DevRel #DevReljp #エンジニア #ドキュメント #スキル pic.twitter.com/g8fHcXq7iG
2022-07-06 19:51:11
拡大
じゅん@4/17XRMTG北海道エリアのお世話 5/18VRCミートアップ 9/28💉7
@jun_mh4g
#DevRelJP 概要から具体へ。 全体から部分へ。 情報の整理 テーマを分解していって階層構造をつくる 階層の高い塊から、章・節・項になる pic.twitter.com/kcKeYeZXY2
2022-07-06 19:52:00
拡大
拡大
拡大
拡大
kaz. Suenaga / 末永 和史
@kazSuenaga
整理の鉄則 わかりにくい相談をする人とか、この逆を行っていることが多いなあ。 #devreljp #devrel pic.twitter.com/LW7gTHcjkE
2022-07-06 19:52:16
拡大
拡大
拡大
拡大
じゅん@4/17XRMTG北海道エリアのお世話 5/18VRCミートアップ 9/28💉7
@jun_mh4g
#DevRelJP Webの記事の場合はこんな感じ pic.twitter.com/8Wg8KmV1e5
2022-07-06 19:52:32
拡大
じゅん@4/17XRMTG北海道エリアのお世話 5/18VRCミートアップ 9/28💉7
@jun_mh4g
#DevRelJP サイボウズの製品の例 pic.twitter.com/BeJKtFBCpp
2022-07-06 19:53:07
拡大
mochiko
@mochikoAsTech
Zoomで #DevRelJP に参加中ー。 twitter.com/jun_mh4g/statu…
2022-07-06 19:53:07
じゅん@4/19XRミーティング北海道エリアのお世話 10/22💉5
@jun_mh4g
#DevRelJP 本日のタイムテーブル なかたさんのかわりに和氣さんのトークに交代とのこと pic.twitter.com/Bd4qmdlBNG
2022-07-06 19:19:27
Taro Nakanishi
@nana_nigiiro
議事録書くときに、以下二つは絶対に言われるし、常に意識している 1.曖昧な言葉は使わない(Effectiveness) 2構造化する(Efficiency) #DevReljp
2022-07-06 19:53:14
kaz. Suenaga / 末永 和史
@kazSuenaga
Kintone での例 （このセッション自体が全体から部分へ、概要から具体へ向かって、具体例を出しているのが面白い） #devreljp #devrel pic.twitter.com/rSTkrf4wPP
2022-07-06 19:53:35
拡大
chihiro
@chihiro0940
一つ一つのページにテーマがあって、全体として一つのテーマを表す 「一言で言うと？」ってことよね。詳細を書いていると、だらだら書いちゃって何が言いたいんだっけ？ってなりがち。さらに大テーマからも外れがち。気をつけよう。 #DevReljp
2022-07-06 19:53:56
じゅん@4/17XRMTG北海道エリアのお世話 5/18VRCミートアップ 9/28💉7
@jun_mh4g
#DevRelJP 段階を追って知識を付け加えていくことが分かりやすさに繋がる じいちゃんにスマホを教える時をイメージせよ pic.twitter.com/baTGbvhBXl
2022-07-06 19:54:26
拡大
拡大
odasho@mabl
@odashoDotCom
頑張ったｧ！！(´Д` )←全て私物 #DevRel #DevReljp twitter.com/kondoyuko/stat…
2022-07-06 19:54:29
近藤佑子
@kondoyuko
DevRel Meetupオフライン会場に参加しましたー！テクニカルライティング特集ということで気になる話です。 ハイブリッド配信環境すごい！ devrel.connpass.com/event/250808/ #DevReljp pic.twitter.com/5LubzErSkT
2022-07-06 19:42:23
じゅん@4/17XRMTG北海道エリアのお世話 5/18VRCミートアップ 9/28💉7
@jun_mh4g
卒論はオカンにつたえて分かるように書いてねと指導していたな('ω') #DevRelJP twitter.com/jun_mh4g/statu…
2022-07-06 19:54:56
Journeyman(ジャニ)🍑🥟 03/02(土) #JAWSDAYS2024 E-1登壇🦈
@beajourneyman
#DevReljp 段階を追って、知識を付け加えていくコトが、分かりやすさに繋がる。
2022-07-06 19:55:09
kaz. Suenaga / 末永 和史
@kazSuenaga
構造ができていることによって、検索性も高まる。 #devreljp #devrel pic.twitter.com/fE9GNlISSB
2022-07-06 19:56:11
拡大
拡大
遙🌗PowerAppでツヨツヨエンジニアになりたい
@yharuka0126
DevRel Meetup in Tokyo #76 〜分かりやすいドキュメントを学ぼう〜に参加を申し込みました！ devrel.connpass.com/event/250808/?… #devreljp
2022-07-06 19:58:03
chihiro
@chihiro0940
情報の分解のやり方 きれいに分解するんではなくて、読者の目的に合わせる これいつも迷ってた。そしてそれは綺麗に分解しようとしていたからか！と気づいた！ #DevReljp
2022-07-06 19:58:04
Taro Nakanishi
@nana_nigiiro
情報分解したツリーは筆者からするとMECEかどうか把握できるし、読み手は欲しい情報にアクセスしやすいからほんと大事 #devreljp pic.twitter.com/NYIV5Xz03x
2022-07-06 19:58:11
拡大
じゅん@4/17XRMTG北海道エリアのお世話 5/18VRCミートアップ 9/28💉7
@jun_mh4g
#DevRelJP どこに何が書いてあるかわかるように適切なタイトルと見出しを付けよう そうすると読者がどこ見ればいいのかそれぞれ見つけやすくなる 分解の方針は、読者の目的に合わせるというのが〇 pic.twitter.com/bWHRXyRp4D
2022-07-06 19:58:13
拡大
拡大
拡大
拡大
職業「戸倉彩」👩💻 Women in Data Science Ambassador
@ayatokura
「読者が情報を探しやすくなること」 テクニカルドキュメントの場合、タイトルや見出し、階層なども大切ですが、最後はドキュメントを作成または公開された方々の思いやりが詰まっていたりするように思うなど。 #DevRel #DevReljp
2022-07-06 19:58:20
Atsushi@MOONGIFT
@goofmint
個人的にはこちらの方がドキュメント向きかなと思うかなぁ。機能ベースはAPIドキュメントとか #DevRel #DevReljp 読み手理解によるか… pic.twitter.com/HHtuzdmlPa
2022-07-06 19:58:23
拡大