ドキュメントの話、しませんか？ #428rk01

小宮健(Takeshi KOMIYA) @tk0miya
#428rk01

Who am I ?
 仕事
 (株)タイムインターメディア所属
 参加コミュニティ
 Sphinx-users.jp
 Python mini hack-a-thon
 Python の方から来ました
 sendagaya.rb (先週初参加)
 Tokyu RubyKaigi
 元Rubyist です(1.4, 1.6の頃)
Twitter: @tk0miya

Who am I ?
 blockdiag というツールを作ってます
 テキスト(DSL like .dot)から画像を生成します
{
トップページ-> ログイン-> マイペー
ジ;
トップページ-> 商品一覧-> 商品詳細;
}

ドキュメントの話、しませんか？
 ドキュメント仲間
 ドキュメントツールについて語り合いたい
 テキストマークアップのツールを作りたい、改善し
たい
 たとえば？

 ドキュメントツールの話題って？
 出力フォーマットの話(とその苦労話)

 表現やメンテナンスについて(とその苦労話)

さがしてます：DocTool Friends
 ドキュメントの用途(とその苦労話)

出版

 マークアップ言語(とその苦労話)

 たとえばmarkdown を例に取って
 どんなツールを使ってますか？
 Github? Jekyll? Octpress? Pandoc? md2inao? reveal.js?
 どうやって編集してますか？
 Vim? Emacs? Kobito? Sublime? etc?
 困ってること、工夫してることありますか？
 画像の作り方、環境の作り方、シェアの仕方、etc.
 markdown で表現できないことはどうしてる？
標準化ってどうなってますか？

 Markdown 2 (http://markdown2.github.io/site/)
作られたっきり更新されてない…

 Internet Draft (The text/markdown Media Type)
 2014/7/4 に公開
 Content-Type: text/markdown; charset=UTF-8;
flavor=GitHub
 the IANA Markdown Flavors Registry
 本気なの!?
 2014/9/9 に更新されてた
 Content-Type: text/markdown; charset=UTF-8;
rules=GitHub
 flavor → rules に変更
 まだ続く模様(9/22, 10/17 と更新されている…)

 standardmarkdown.com
 A strongly specified, highly compatible
implementation of Markdown
＿人人人人人人人人人人人人人人人人人＿
＞突然のThis domain was disabled ＜
￣Y^Y^Y^Y^Y^Y^Y^Y^Y^Y^Y^Y^Y^Y^Y^Y￣
 John Gruber (markdown 作者) からツッコミが！
 リネームすることになった
 Standardmardown.com を閉じることになった
 謝罪することになった

 commonmark.com
 元standardmarkdown
 仕様も実装もある
 The current version of the CommonMark spec is
complete と言ってる
 そのうち1.0 がでるらしい
 これはstandard になるのか?
 新たなflavor の登場になってしまうのか?
 markdown だけでもこれだけ話題がある
 詳しくは今月のWEB+DB の@takahashim の記事で！

 他にも切り口はたくさんある
 出版する際の注意点、ツール選び
 翻訳に役立つツール
 ドキュメントの翻訳で本家の更新を追いかける方法
 同人誌を作るときのポイント
 用語を統一する方法
 自動生成(API リファレンスなど)
 その他もろもろ

 話題はあるのに場がない(ような気がする)
 ドキュメントコミュニティはバラバラに活動している
 マークアップ言語ごと
 プログラム言語ごと(Ruby 界隈、Python 界隈…)
 活動(出版、翻訳…)
 知見が共有されづらい
 ツールも共有されづらい
 バラバラに同じ問題を解決し続けている
 そんな話をする仲間がほしい!!
 工夫してること、苦労してること、シェアしたい

 来月に版管理+自動組版というイベントがあります
 まずは版管理や組版(出版方面)の話から

まとめ
 ドキュメントの話、しませんか？
 工夫してること、苦労してること、気になっ
てること、シェアしませんか
 やりかたはこれから考えていきます
 詳しくは@tk0miya まで！

ドキュメントの話、しませんか？ #428rk01

Related slideshows

More Related Content

ドキュメントの話、しませんか？ #428rk01

Editor's Notes