本当のドキュメントと向き合えますか

小宮 健 (@tk0miya)2011-04-09

自己紹介小宮 健 (@tk0miya)株式会社タイムインターメディア所属プログラマやってます。#qpstudy 初参加ですSphinx-users の方から来ました

今日のテーマドキュメントの図について話します

普段、どんな図を書いてますか？システム構成図ネットワーク図連絡フローなどなど

その図、更新できてますか ?夢の中では、あったような…あればとっても嬉しいなって運用で対応も、あるんだよドキュメントなんてあるわけない白紙のドキュメントと向き合えますか

作ったけど更新しない↓

( 担当者の ) 緩やかな死

というわけでなるべく更新しましょう

更新できないのはなんでだろうコストがたりないみんな重要さに気づいてない更新するの面倒くさい

今日はここに注目

Excel 方眼紙時代の思い出

苦労 その１：追加 / 削除が大変ここに 1 画面追加

苦労 その１：追加 / 削除が大変１ . スキマを作る

苦労 その１：追加 / 削除が大変２ . 図形を置く ３ . 矢印を調整

苦労 その２：ずれる

苦労 その２：ずれる

苦労 その２：ずれる

苦労 その２：ずれる

というわけでExcel 、 Visio の代わりを作りました

*diag シリーズテキストを図に変換するツール群

blockdiag ：ブロック図seqdiag ：シーケンス図actdiag ：アクティビティ図

テーマ：きれいな図よりメンテできるテキスト

blockdiag の例このテキストが…

diagram { A -> B -> C; B -> D;}

blockdiag の例 こうなる

seqdiag の例このテキストが…

diagram { browser => server;}

seqdiag の例 こうなる

あれ、インフラ全然関係なくね ?

というわけでネットワーク図に対応しました。

*diag シリーズテキストを図に変換するツール群

blockdiag ：ブロック図seqdiag ：シーケンス図actdiag ：アクティビティ図netdiag ：ネットワーク図 [New!]

プロトタイプ版です :p ドキュメントとか明日あたりに書きます (>_< まだ 8 時間しか手がけてないのでボロがたくさんあります。

netdiag の例 このテキストが…

diagram { network dmz { address = "210.x.x.x/24” web01; web02; } network internal { address = "172.x.x.x/24” db01; db02; } dmz -- internal}

netdiag の例 こうなる

デモ時間が残ってたらやります。

ブラウザ上で動くように加工したバージョンです。http://blockdiag.appspot.com/http://blockdiag.appspot.com/seqdiag/http://blockdiag.appspot.com/actdiag/http://blockdiag.appspot.com/netdiag/

まとめドキュメントはちゃんと更新しましょうdiag シリーズがおすすめです。

blockdiag, seqdiag, actdiag, netdiag でググってね

ネットワーク屋さん向け ? に netdiag を作ったよもちろん Sphinx もおすすめです。