Markdownを使ったドキュメントサイト構築
受講スキル
以下の方に受講いただくことが望ましいです。 ・Gitの操作に馴染みのある方 ・Markdownやnode.jsについて知見がある方 ・ウェブサイト構築の経験がある方
受講者が得られるであろう知見
・効率的なドキュメントサイトの構築の手法 ・ビルド・デプロイの自動化 ・軽量マークアップから高品質なHTMLを出力する手法
セッションの内容
■概要
マニュアルや仕様書、APIリファレンスなど、ドキュメント制作に関わる工数が日々の開発業務を圧迫してはいないでしょうか。
例えばMarkdownであればソースコードと共にGit上で管理できるうえ、HTMLのコーディングに比べ特別な知識が要りません。また、SSG/SPA/CI/PWA/BaaSと言ったOSSの技術を組み合わせることで、ハイクオリティかつハイパフォーマンスなドキュメントサイトのHTML出力からデプロイまでを自動化することができます。
モダンな技術を使うことで、安価かつ簡便にドキュメントサイトを構築する手法を紹介いたします。
■対象となる方
・マニュアルや仕様書、APIリファレンスを作成している方
・Markdownに馴染みがある方
・ドキュメントをWordやWikiなどで管理している方
講演資料
※資料のダウンロードには ログイン が必要です。
講演者プロフィール
プロフィール
私は名古屋のゲーム開発会社でキャリアをスタートし、萌ゲーの開発に奮闘しておりました。めぐりめぐって現在は、ドキュメント業界でコンサルティング業に従事し、ゲーム業界とドキュメント業界双方の経験を活かした、「ドキュメント制作のお悩みをテクノロジーの力で解決する」独自のノウハウを提供しています。
先進的な技術・知見を持つ企業様であっても、「マニュアル」や「APIリファレンス」など「ドキュメント」制作という点に限れば、案外無駄なコストを発生させているものです。
GitやCIツールなど、開発現場で使い慣れたツールでドキュメント管理も一括して行うことでコスト削減に繋げようというのが、私の発表の趣旨になります。
《講演者からのメッセージ》
ゲーム開発にとって副次的なタスクに関わらず、どうしても外せないのが「マニュアル」や「仕様書」などのドキュメント制作です。
本発表では、できるだけ簡便かつ安価にドキュメントの制作・管理コスト削減につなげる手法を紹介いたします。
プロフィール
1999年に株式会社ヒューマンサイエンスへ入社。
各種ソフトウェア／ハードウェアのユーザー向けコンテンツ執筆、ドキュメント制作ディレクションを担当。
2012年～2015年に大手ゲーム開発会社に出向し、ゲームエンジンのマニュアル整備を行う。
また、2015年～2016年にリアルタイムCG・ゲーム開発会社に常駐し、マニュアル改善およびチュートリアル執筆に従事。
その他、ゲーム開発会社のドキュメントを多数整備し、管理コスト削減につなげる。
《講演者からのメッセージ》
皆様のご来場をお待ちしております！