歌舞伎座.tech#14「OSSドキュメンテーション勉強会」

イベント内容

日頃、OSSのドキュメントの書き方に悩んでいる人たちが集まって知見を共有する 勉強会です。

たとえば、

  • APIドキュメントをどう書くか
  • チュートリアルをどう書くか
  • ドキュメント内に各種要素をどう配置するか
  • ドキュメント生成ツールについて
  • 英語ドキュメントを書く場合の注意

といったことについて知見を共有できればと考えています。

主に、OSSのドキュメントを書く立場からの発表を募集しますが、読む側から、「こうなっていて欲しい」という 発表でも構いません。対象となるプログラミング言語等は問いませんし、非プログラマ向けのソフトウェアの ドキュメントについても対象範囲内です。

参加資格は特にありません。

例:

  • README.md に書くべきこと
  • APIドキュメントへの導線
  • APIドキュメントには、何を書いて、何を書かないべきか

注意

  • 運営側で難易度調整することはないので、発表内容が理解できない(かもしれない)ことを覚悟しておきましょう

発表者募集

  • 発表者を先着で募集中です。
  • 発表枠に登録した方を順次管理者に登録するので、発表タイトル編集は各自で行ってください。 発表者になってタイトルも決まったのに、しばらく経っても管理者にしてもらえなかったら、 管理者の誰かにtwitter上で問い合わせるなどしてください

発表時間目安

  • 20~40分くらい(発表者数によって増減)

参加費

無料です。

懇親会を行う予定はありません。

会場

会場はドワンゴ セミナールーム(松竹スクエア 13F)です。

入場方法

地下鉄各線東銀座駅5番出口から地上にあがって、橋を渡ったところにあるビルです。 正面入口から入り奥にあるエレベーターで13Fまであがってください。

電源タップについて

無線LANと電源はありますが、電源は床埋込み式で Macのアダプタが刺さりません 。 電源タップをご持参ください。

その他

  • 喫煙室はありません
  • 貴重品は各自で管理してください
  • 会場は飲食可能です

暫定タイムテーブル

発表タイトルは予告なく変更される可能性があります。

時間 概要 or 仮発表タイトル 話す人
13:30 ~ 開場
14:00 ~ 14:30 @kmizu
14:30 ~ 14:45 休憩
14:45 ~ 15:15 how to manage the document of Node.js Yuta Hiroto
15:15 ~ 15:30 休憩
15:30 ~ 16:15 C++リファレンスサイトcpprefjpでのドキュメンテーション @cpp_akira
16:15 ~ 16:30 休憩
16:30 ~ 17:15 単語の揺らぎに対処するための手法と実装 @takahi_i
17:15 ~ 17:30 休憩
17:30 ~ 18:00 LT

LT枠

時間 概要 or 仮発表タイトル 話す人
17:30 ~ 17:35 ドキュメントを直し続ける話 @shigemk2
17:35 ~ 17:40 OSSのやりすぎたマニュアル @EzoeRyou
17:40 ~ 17:45 Continuous API documentation: Docstandのご紹介 @kobadora

注意事項

※ こちらのイベント情報は、外部サイトから取得した情報を掲載しています。
※ 掲載タイミングや更新頻度によっては、情報提供元ページの内容と差異が発生しますので予めご了承ください。
※ 最新情報の確認や参加申込手続き、イベントに関するお問い合わせ等は情報提供元ページにてお願いします。

類似しているイベント