excel 方眼紙撲滅委員会 活動報告 2013.9 #yapcasia
TRANSCRIPT
Excel 方眼紙撲滅委員会活動報告 2013.9
Sphinx-users.jp小宮健
お前だれよ
仕事( 株 ) タイムインターメディア所属テクニカルオフィサ ( 技術責任者 ) として活動
参加コミュニティSphinx-users.jpPython mini hack-a-thon
Sphinx を中心にツールを開発blockdiag シリーズSphinx 拡張機能の開発
Googlechart やカレンダー機能#bookathon 他読書会やってます
Twitter: @tk0miya
Excel 方眼紙撲滅委員会とは
Excel 方眼紙撲滅委員会とは
Excel 方眼紙を撲滅するための秘密結社表計算はいいと思いますツールを作って / 使って楽したい
要は『適材適所』しようということ
ひとり委員会です。
前回までのあらすじ
Excel 方眼紙を廃止するためにツールを作った
blockdiag シリーズテキストから画像を生成するツール群ブロック図、シーケンス図、ネットワーク
図など
blockdiag の例このテキストが…
{ トップページ -> ログイン -> マイページ ; トップページ -> 商品一覧 -> 商品詳細 ;}
seqdiag の例このテキストが…
{ A => B => C;}
nwdiag の例
このテキストが…
{ network { web01; web02; } network { web01; web02; db01; }}
今回の活動報告
今回のターゲットはドキュメント
ドキュメントとしても Excel は使われてる
バージョン管理が難しい基本設計書 _20130901.xlsx基本設計書 _20130901_2.xlsx基本設計書 _20130901 最新 .xlsxもちろんマージできない
差分管理が難しいやはり Excel は撲滅されるべきである!
そうだ、 Sphinx を使おう
Sphinx とは
テキスト (reST) から各種フォーマットへ変換HTML, PDF など多くのフォーマットに
対応
Sphinx とは
Sphinx の特徴
シンプルなマークアップreST (reSTructured Text)テキストのままでも見やすい======見出し======
* 箇条書き* 箇条書き
Sphinx のよいところ
ソースがテキスト形式環境 / エディタを選ばないバージョン管理できるツールで自動生成しやすい
例 ) schema2rst (DB 定義抽出 )機能を拡張することが出来る
Sphinx 拡張やテーマで表現力アップ目次 (toctree) ベースなので文章が書きやすい
Sphinx のいまいちなところ
変換する必要があるreST を書いて make する、の繰り返しツールを使って自動化できるが…
reST は文書レイアウトを表現できない右寄せ、センタリング、二段組などの表現
がない割り切りが必要
画像や図などは別途作る必要があるOffice スイートになれていると、ちょっと
不便 :-(
Sphinx の主な用途
開発ドキュメントPython 等 OSS のドキュメント設計書、マニュアルなど
Web サイトブログ風、コーポレートサイト
出版エキスパート Python プログラミングPython プロフェッショナルプログラミングその他多数
他のツールとの比較
Excel◯ 誰でも使える。事実上の標準ツール◯ 方眼紙ライクな図、説明が書きやすい✕ 文章構成が存在しない✕ 編集、とくにセルの調整を始めると…✕ 印刷しづらいドキュメントができる✕ Office スイートが必要
他のツールとの比較
Wiki◯ ブラウザだけで編集できる◯ 記法がわかりやすく書きやすい✕ 図や画像は別途作成する必要がある✕ 構成がネットワーク状で迷子になりや
すい✕ 文書レイアウトは指定しづらい ( できな
い )
他のツールとの比較
POD◯ エディタだけで編集できる◯ 書き慣れている✕ 図や画像は別途作成する必要がある✕ 文書レイアウトは指定しづらい ( できな
い )✕ Perl モジュール以外のことは書きづら
い
『 Sphinx をはじめよう』
世界初の Sphinx 本電子書籍100 ページ弱相当オライリー・ジャパン1,680円
2013/9/13 発売ターゲット
初めて使う人周囲への布教用
今回のターゲットはドキュメント
デモ時間があれば…
まとめ
Sphinx 本書きましたけっこう Sphinx 便利だと思います10月に Hackathon/ハンズオンやります
イベントサイト connpass で募集中
blockdiag もよろしく
おまけ
Pandoc を使って markdown を使うプラグイン書きました
Sphinx 文書に markdown フォーマットを利用するhttp://tk0miya.hatenablog.com/entry/2012/12/1
9/233642