ドキュメントの話、しませんか？

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

Who am I ?

仕事( 株 ) タイムインターメディア所属

参加コミュニティSphinx-users.jpPython mini hack-a-thonPython の方から来ましたsendagaya.rb ( 先週初参加 )Tokyu RubyKaigi

元 Rubyist です (1.4, 1.6 の頃 )

Twitter: @tk0miya

Who am I ?

質問来ませんでした！

Who am I ?

blockdiag というツールを作ってますテキスト (DSL like .dot) から画像を生成します

{ トップページ -> ログイン -> マイページ ; トップページ -> 商品一覧 -> 商品詳細 ;}

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

たい

たとえば？

ドキュメントの話、しませんか？ドキュメントツールの話題って？出力フォーマットの話 ( とその苦労話 )

ドキュメントの話、しませんか？ドキュメントツールの話題って？出力フォーマットの話 ( とその苦労話 )

HTMLPDF

ePub

ePub ( 縦書き )HTML + JS

ドキュメントの話、しませんか？ドキュメントツールの話題って？出力フォーマットの話 ( とその苦労話 )表現やメンテナンスについて ( とその苦労話 )

ドキュメントの話、しませんか？ドキュメントツールの話題って？出力フォーマットの話 ( とその苦労話 )表現やメンテナンスについて ( とその苦労話 )

画像の埋め込み数式

その他 ( 動画、 slideshare)

自動生成 / 抽出

シェアする方法

継続的メンテナンス

拡張方法Cacoo

テーブル

Visio

Astah

さがしてます： DocTool Friends

ドキュメントツールの話題って？出力フォーマットの話 ( とその苦労話 )表現やメンテナンスについて ( とその苦労話 )ドキュメントの用途 ( とその苦労話 )

ドキュメントの話、しませんか？ドキュメントツールの話題って？出力フォーマットの話 ( とその苦労話 )表現やメンテナンスについて ( とその苦労話 )ドキュメントの用途 ( とその苦労話 )

手順書 マニュアル出版

仕様書

スライド

Web サイトブログ リファレンス

ドキュメントの話、しませんか？ドキュメントツールの話題って？出力フォーマットの話 ( とその苦労話 )表現やメンテナンスについて ( とその苦労話 )ドキュメントの用途 ( とその苦労話 )マークアップ言語 ( とその苦労話 )

ドキュメントの話、しませんか？ドキュメントツールの話題って？出力フォーマットの話 ( とその苦労話 )表現やメンテナンスについて ( とその苦労話 )ドキュメントの用途 ( とその苦労話 )マークアップ言語 ( とその苦労話 )

markdown

Re:VIEW

reStructured TextTeX

RD/rdoc

YARD

textile

各種 Wiki 文法

org-modePOD はてな記法 AsciiDoc

DocBookroff

XML

ドキュメントの話、しませんか？たとえば 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=GitHubthe IANA Markdown Flavors Registry本気なの !?

2014/9/9 に更新されてたContent-Type: text/markdown; charset=UTF-8;

rules=GitHubflavor → rules に変更まだ続く模様 (9/22, 10/17 と更新されている… )

ドキュメントの話、しませんか？

standardmarkdown.comA strongly specified, highly compatible

implementation of Markdown

John Gruber (markdown 作者 ) からツッコミが！リネームすることになったStandardmardown.com を閉じることになった謝罪することになった

＿人人人人人人人人人人人人人人人人人＿＞　突然の This domain was disabled 　＜￣ Y^Y^Y^Y^Y^Y^Y^Y^Y^Y^Y^Y^Y^Y^Y^Y ￣

ドキュメントの話、しませんか？

commonmark.com元 standardmarkdown仕様も実装もあるThe current version of the CommonMark spec

is complete と言ってるそのうち 1.0 がでるらしい

これは standard になるのか ?新たな flavor の登場になってしまうのか ?

markdown だけでもこれだけ話題がある詳しくは今月の WEB+DB の @takahashim の記

事で！

ドキュメントの話、しませんか？

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

ドキュメントの話、しませんか？

話題はあるのに場がない ( ような気がする )ドキュメントコミュニティはバラバラに活動している

マークアップ言語ごとプログラム言語ごと (Ruby 界隈、 Python 界隈

… )活動 ( 出版、翻訳… )

知見が共有されづらいツールも共有されづらいバラバラに同じ問題を解決し続けている

そんな話をする仲間がほしい !!工夫してること、苦労してること、シェアしたい

ドキュメントの話、しませんか？

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

まとめ

ドキュメントの話、しませんか？工夫してること、苦労してること、気になっ

てること、シェアしませんかやりかたはこれから考えていきます詳しくは @tk0miya まで！