【Online】LINE Technical Writing Meetup vol. 26

2023/07/13(木)19:00 〜 20:40 開催

ブックマーク

#Python, #Android, #HTML

イベント内容

LINE Technical Writing Meetup

LINE Technical Writing Meetupは、テクニカルライティングをテーマにした技術者向けのミートアップです。
エンジニアをしていると、日々仕事でドキュメントを書いたり読んだり、あるいは個人的に調べたことをブログにまとめたり、公私を問わず技術的な文章に触れる機会が多いと思います。
もっと分かりやすいドキュメントが書けるようになりたいな、複雑な技術のこともうまく伝えられるようになりたいな、そんな風に「書くこと」や「つたえること」について課題感を持っている方も少なくないのではないでしょうか。
このミートアップでは、LINEでテクニカルライティングを専門としているメンバーが集まって、もっと「分かりやすくつたえる」ための知見を共有していきます。

※参加費無料

※このイベントは日本語と韓国語で行われます。
※韓国語のセッションは日本語通訳をご用意しています。

開催日時

2023年7月13日(木） 19:00-20:40

開催場所

オンライン
※Zoomで配信をしますので、必ず事前登録をお願いします。
※アーカイブは後日公開を予定しています。

こんな人におすすめ

ドキュメントを書いたり読んだりする人
技術を分かりやすくつたえられるようになりたい人
「書くこと」や「つたえること」に課題感を持っている人
技術ブログなどでアウトプットをしている人
開発や運用をしながらドキュメント作りもがんばっている人
もっと文章力を上げたいと思っている人
分かりやすく説明できるようになりたい人
技術書を執筆している人

質問の受付について

当日発表者に対する質問は以下URLから受け付けます（事前の質問も歓迎です）
https://app.sli.do/event/6yKMJxRizLBw1KBeBUtA39
sli.doのトップページ（ https://www.sli.do/ ）でイベントコード「TWM26」を入力しても、質問受付ページに参加できます。

参加される方への事前のお願い

インターネットが良好に繋がる環境にてご視聴ください。
視聴端末（PC/iPad/iPhone/Android）にZoomをインストールの上、サインアップ/サインインして下さい。
サインインされた後、お名前の表記や写真を変更するなど、個人情報が表示されないようご注意ください。
Zoomのダウンロードはこちらから：https://zoom.us/support/download
申し込んだ方には、開催当日に視聴URL（および参加後アンケートのURL）をメッセージでお送りします。
開始10分前から入室が可能です。
参加後は、アンケートへの回答にご協力をお願いします。
Twitterでのイベントに関する投稿も大歓迎です！
ハッシュタグ：[#LINE_TWM]

タイムスケジュール

時間	コンテンツ	登壇者
19:00-19:05	Opening	―
19:05-19:35	YAMLで同一フォーマットのコンテンツ管理をラクにする	Ragina Jeon / LINE Plus
19:35-20:05	ドキュメントの継続的改善 ― Sphinxを使いながら	篠崎宗一郎 / アプトポッド
20:05-20:35	Q&A	―
20:35-20:40	Closing	―

セッション概要

YAMLで同一フォーマットのコンテンツ管理をラクにする

Ragina Jeon / LINE Plus / a document engineer & tech writer

テクニカルライティングを始めたばかりのころ、MarkdownやWikiに書かれたAPIドキュメントの扱いに課題を感じていました。しかし、APIの説明にYAML形式を使うことで、スタイルの変更や特定のフィールドを追加／削除するプロセスを効率化できることが分かりました。この形式は、他にも用語集のような同一フォーマットが繰り返されるコンテンツにも適用できます。このセッションでは、技術ドキュメントにYAML形式を採用することで、同一フォーマットのコンテンツ管理をラクにする方法を紹介します。

ドキュメントの継続的改善 ― Sphinxを使いながら

篠崎宗一郎 / (soishino )/ 株式会社アプトポッド / テクニカルコンテンツディレクター

このセッションでは、「社内で1人だけのドキュメント担当」が、Sphinxを使いながら進めてきた、ドキュメント制作方法の改善についてご紹介します。
これまで3年ほど、社外向けドキュメントの制作ツールとしてSphinxを使用してきました。Sphinxはとても柔軟なすばらしいツールです。最初はPDF出力の機能に魅力を感じて使い始めたのですが、最近は同じSphinxを使い続けながらも、出力はHTML形式をメインにするようになりました。Sphinxの多彩な機能や柔軟性を活かし、無理なくHTMLでの公開に移行するとともに、アクセス解析の導入や、検索機能の向上、HTMLならではの表現の導入などの改善を進めてきました。その過程を、一例としてお話できればと思います。
特に、「マニュアルを作るのに何か良いツールはないかな？」と探している方に、また「Sphinxってどんなものなのかな」と思っている方に、参考になればと思っています。また、今後もドキュメントの改善を続けていくために、アドバイス、ご意見などいただけるとうれしいです。

注意事項

本イベントの内容は後日、主催団体のブログ・YouTube等の媒体にて紹介する可能性があります。その際、ご参加者名が写った画像（キャプチャなど）も紹介されることがあります。予めご了承ください。
当社におけるその他取り扱いは以下プライバシーポリシーに従います。ご同意の上、ご参加ください。 https://terms.line.me/line_rules/?lang=ja
イベントスタッフは、このイベントに関わる全員が気持ちよく過ごせるように考えています。参加者の皆様も、他の方を不快にさせるような発言・行動は謹んでください。またそのような行動を目にした方は、connpassの「イベントへのお問い合わせ」フォームからお知らせください。