用語説明の悩みをマークダウンの機能拡張で解決した話 / How we solved the problem of terminology explanation with markdown extension

Slide 1

Slide 1 text

LINE Technical Writing Meetup vol. 9 ⽤語説明の悩みをマークダウンの機能拡張で解決した話 LINE Corporation Developer Content Team Yoshiko Horikoshi 20th January 2022 19:00-21:00

Slide 2

Slide 2 text

1: ⽤語説明の悩みをマークダウンの機能拡張で解決した話 2: 伝わる⽂章を考えるために〜テクニック以外に⼤切なことは︖〜 3: Questions and Answers 20th January 2022 19:00-21:00 LINE Technical Writing Meetup vol. 9

Slide 3

Slide 3 text

発表資料はSlideShareでも公開しますので発表内容や画⾯キャプチャ、動画のURLなどは⾃由にツイートしてください

Slide 4

Slide 4 text

⾃⼰紹介

Slide 5

Slide 5 text

はじめまして「ほりこし」です

Slide 6

Slide 6 text

LINE Corporation Developer Content Team

Slide 7

Slide 7 text

2020年1⽉から LINEでテクニカルライター

Slide 8

Slide 8 text

Yoshiko Horikoshi @mochikoAsTech プログラマ（3年）広報（4年）インフラエンジニア（7年） 2020年1⽉からLINEでテクニカルライター

Slide 9

Slide 9 text

「テクニカルライターってなに︖」と思ったら LINEの開発者向けドキュメントを⽀える「テクニカルライティング」の専⾨チームというセッションの動画と記事をどうぞ https://www.youtube.com/watch?v=HjKvDK50iY0 https://logmi.jp/tech/articles/325624

Slide 10

Slide 10 text

今⽇話す内容

Slide 11

Slide 11 text

突然ですが…

Slide 12

Slide 12 text

機能や⼿順や仕組みについての説明を書いているときその説明の中で初めて出てきた⽤語をどこまで説明するか迷ったことはありませんか︖

Slide 13

Slide 13 text

あるある︕ という⼈は挙⼿

Slide 14

Slide 14 text

新しいLIFFスターターアプリは、現時点では vanilla JavaScriptのみをサポートしています。今後、Next.jsやNuxtといった JavaScriptフレームワークについてもサポートする予定です。 https://developers.line.biz/ja/news/2021/11/02/new-liff-starter-and-playground/

Slide 15

Slide 15 text

https://developers.line.biz/ja/news/2021/11/02/new-liff-starter-and-playground/

Slide 16

Slide 16 text

Slide 17

Slide 17 text

vanilla JavaScript という⽤語⾃体は各社のドキュメントにも出てくる（おそらく）⼀般的な⽤語

Slide 18

Slide 18 text

vanilla JavaScript とは何かを説明すべきか︖

Slide 19

Slide 19 text

https://developers.line.biz/ja/news/2021/11/02/new-liff-starter-and-playground/

Slide 20

Slide 20 text

vanilla JavaScript という⽤語を使わずに「純粋な」「ただの」 JavaScriptと書くか︖

Slide 21

Slide 21 text

説明すべきか説明せざるべきか︖

Slide 22

Slide 22 text

機能や⼿順や仕組みについての説明を書いているときその説明の中で初めて出てきた⽤語をどこまで説明するか迷う

Slide 23

Slide 23 text

今⽇のセッション︓ ⽤語説明の悩みをマークダウンの機能拡張で解決した話

Slide 24

Slide 24 text

説明の中で初めて出てきた⽤語をどこまで説明するか迷う…という悩みを LINE Developersサイトではこんな⾵に解決しました

Slide 25

Slide 25 text

LINE Developersサイト https://developers.line.biz/

Slide 26

Slide 26 text

はじまりはじまり︕

Slide 27

Slide 27 text

https://developers.line.biz/ja/news/2021/11/09/messaging-api-update/

Slide 28

Slide 28 text

メッセージスタンプでユーザーが⼊⼒したテキストを取得できるようになりました

Slide 29

Slide 29 text

ちょっと本筋から脱線

Slide 30

Slide 30 text

Messaging APIとは︖

Slide 31

Slide 31 text

https://www.linebiz.com/jp/manual/OfficialAccountManager/gain-friends/

Slide 32

Slide 32 text

LINE公式アカウントからユーザーにメッセージを送ったりユーザーからのメッセージをWebhookで受け取ったりなどいろいろできるMessaging API https://developers.line.biz/ja/docs/messaging-api/overview/

Slide 33

Slide 33 text

No content

Slide 34

Slide 34 text

No content

Slide 35

Slide 35 text

好きなテキストを⼊⼒して使えるメッセージスタンプ https://creator-mag-ja.line.me/archives/1077517778.html

Slide 36

Slide 36 text

https://developers.line.biz/ja/news/2021/11/09/messaging-api-update/

Slide 37

Slide 37 text

メッセージスタンプを説明すべきか説明せざるべきか︖

Slide 38

Slide 38 text

もっと⼿前のスタンプとは何かから説明すべきか︖

Slide 39

Slide 39 text

いちいち⽤語を解説していたら説明が⻑くなってしまう… でも⽤語説明しないと分からない⼈がいるかも…

Slide 40

Slide 40 text

https://developers.line.biz/ja/news/2021/11/09/messaging-api-update/ ⽤語集ツールチップ

Slide 41

Slide 41 text

https://developers.line.biz/ja/glossary/ LINE Developersサイトには⽤語集がある

Slide 42

Slide 42 text

https://developers.line.biz/ja/news/2021/11/09/messaging-api-update/ ⽤語集ツールチップ

Slide 43

Slide 43 text

⽤語説明が⼀箇所で済むし必要ない⼈には邪魔にならないいいとこ取りな⽤語集ツールチップ

Slide 44

Slide 44 text

⽤語集ツールチップの裏側

Slide 45

Slide 45 text

VuePress

Slide 46

Slide 46 text

注釈が書きたい︕ コードサンプルをタブで表⽰したい︕

Slide 47

Slide 47 text

VuePressはVue.jsで書かれているのでマークダウンの機能を Vue.jsコンポーネントで拡張できる

Slide 48

Slide 48 text

⽤語集のページにリンクを貼るだけ

Slide 49

Slide 49 text

config.js（の⼀部）

Slide 50

Slide 50 text

↓

Slide 51

Slide 51 text

GlossaryTooltip.vue（の⼀部）

Slide 52

Slide 52 text

GlossaryTooltip.vue（の⼀部）

Slide 53

Slide 53 text

説明すべきか説明せざるべきか︖

Slide 54

Slide 54 text

今⽇のセッション︓ ⽤語説明の悩みをマークダウンの機能拡張で解決した話

Slide 55

Slide 55 text

Developer Content Team

Slide 56

Slide 56 text

https://linecorp.com/ja/career/position/806

Slide 57

Slide 57 text

https://linecorp.com/ja/pr/news/ja/2021/3912

Slide 58

Slide 58 text

Slide 59

Slide 59 text

Slide 60

Slide 60 text

このイベントのアーカイブ動画は YouTubeでご覧いただけます https://youtube.com/playlist? list=PL80ip6bOwQsIfO757li02S42XDdWdnmED

Slide 61

Slide 61 text

次回のLINE Technical Writing Meetupは 2⽉10⽇(⽊) 19:00に開催決定 https://line.connpass.com/event/236274