1. 本当のドキュメントと向き合えますか 小宮 健 (@tk0miya) 2011-04-09

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

3. 今日のテーマ ドキュメントの図について話します 普段、どんな図を書いてますか？ システム構成図 ネットワーク図 連絡フロー などなど

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

5. 作ったけど更新しない ↓ (担当者の) 緩やかな死

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

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

8. Excel 方眼紙時代の思い出

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

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

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

12. 苦労 その２：ずれる

13. 苦労 その２：ずれる

14. 苦労 その２：ずれる

15. 苦労 その２：ずれる

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

17. *diagシリーズ テキストを図に変換するツール群 blockdiag：ブロック図 seqdiag：シーケンス図 actdiag：アクティビティ図 テーマ： きれいな図よりメンテできるテキスト

18. blockdiagの例 このテキストが… diagram { A -> B -> C; B -> D; }

19. blockdiag の例 こうなる

20. seqdiagの例 このテキストが… diagram { browser => server; }

21. seqdiagの例 こうなる

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

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

24. *diagシリーズ テキストを図に変換するツール群 blockdiag：ブロック図 seqdiag：シーケンス図 actdiag：アクティビティ図 netdiag：ネットワーク図 [New!] プロトタイプ版です:p ドキュメントとか明日あたりに書きます(>_< まだ 8 時間しか手がけてないのでボロがたくさんあります。

25. netdiagの例 このテキストが… diagram { network dmz { address = "210.x.x.x/24” web01; web02; } network internal { address = "172.x.x.x/24” db01; db02; } dmz -- internal }

26. netdiagの例 こうなる

27. デモ 時間が残ってたらやります。 ブラウザ上で動くように加工したバージョンです。 http://blockdiag.appspot.com/ http://blockdiag.appspot.com/seqdiag/ http://blockdiag.appspot.com/actdiag/ http://blockdiag.appspot.com/netdiag/

28. まとめ ドキュメントはちゃんと更新しましょう diagシリーズがおすすめです。 blockdiag, seqdiag, actdiag, netdiagでググってね ネットワーク屋さん向け? に netdiagを作ったよ もちろん Sphinx もおすすめです。