本当のドキュメントと向き合えますか @ qpstudy 2011/04

10,063 views

Published on

Published in: Technology
0 Comments
6 Likes
Statistics
Notes
  • Be the first to comment

No Downloads
Views
Total views
10,063
On SlideShare
0
From Embeds
0
Number of Embeds
2,166
Actions
Shares
0
Downloads
12
Comments
0
Likes
6
Embeds 0
No embeds

No notes for slide

本当のドキュメントと向き合えますか @ qpstudy 2011/04

  1. 1. 本当のドキュメントと向き合えますか<br />小宮 健 (@tk0miya)<br />2011-04-09<br />
  2. 2. 自己紹介<br />小宮 健 (@tk0miya)<br />株式会社タイムインターメディア所属<br />プログラマやってます。<br />#qpstudy初参加です<br />Sphinx-users の方から来ました<br />
  3. 3. 今日のテーマ<br />ドキュメントの図について話します<br />普段、どんな図を書いてますか?<br />システム構成図<br />ネットワーク図<br />連絡フロー<br />などなど<br />
  4. 4. その図、更新できてますか?<br />夢の中では、あったような…<br />あればとっても嬉しいなって<br />運用で対応も、あるんだよ<br />ドキュメントなんてあるわけない<br />白紙のドキュメントと向き合えますか<br />
  5. 5. 作ったけど更新しない<br />↓<br />(担当者の) 緩やかな死<br />
  6. 6. というわけでなるべく更新しましょう<br />
  7. 7. 更新できないのはなんでだろう<br />コストがたりない<br />みんな重要さに気づいてない<br />更新するの面倒くさい<br />今日はここに注目<br />
  8. 8. Excel 方眼紙時代の思い出<br />
  9. 9. 苦労 その1:追加/削除が大変<br />ここに 1 画面追加<br />
  10. 10. 苦労 その1:追加/削除が大変<br />1.スキマを作る<br />
  11. 11. 苦労 その1:追加/削除が大変<br />2.図形を置く<br />3.矢印を調整<br />
  12. 12. 苦労 その2:ずれる<br />
  13. 13. 苦労 その2:ずれる<br />
  14. 14. 苦労 その2:ずれる<br />
  15. 15. 苦労 その2:ずれる<br />
  16. 16. というわけでExcel、Visio の代わりを作りました<br />
  17. 17. *diagシリーズ<br />テキストを図に変換するツール群<br />blockdiag:ブロック図<br />seqdiag:シーケンス図<br />actdiag:アクティビティ図<br />テーマ:<br />きれいな図よりメンテできるテキスト<br />
  18. 18. blockdiagの例<br />このテキストが…<br />diagram {<br /> A -> B -> C;<br /> B -> D;<br />}<br />
  19. 19. blockdiag の例<br />こうなる<br />
  20. 20. seqdiagの例<br />このテキストが…<br />diagram {<br /> browser => server;<br />}<br />
  21. 21. seqdiagの例<br />こうなる<br />
  22. 22. あれ、インフラ全然関係なくね?<br />
  23. 23. というわけでネットワーク図に対応しました。<br />
  24. 24. *diagシリーズ<br />テキストを図に変換するツール群<br />blockdiag:ブロック図<br />seqdiag:シーケンス図<br />actdiag:アクティビティ図<br />netdiag:ネットワーク図 [New!]<br />プロトタイプ版です:p<br />ドキュメントとか明日あたりに書きます(>_<<br />まだ 8 時間しか手がけてないのでボロがたくさんあります。<br />
  25. 25. netdiagの例<br />このテキストが…<br />diagram {<br /> network dmz {<br /> address = "210.x.x.x/24” web01; web02;<br /> }<br /> network internal {<br /> address = "172.x.x.x/24” db01; db02;<br /> }<br />dmz -- internal<br />}<br />
  26. 26. netdiagの例<br />こうなる<br />
  27. 27. デモ<br />時間が残ってたらやります。<br />ブラウザ上で動くように加工したバージョンです。<br />http://blockdiag.appspot.com/<br />http://blockdiag.appspot.com/seqdiag/<br />http://blockdiag.appspot.com/actdiag/<br />http://blockdiag.appspot.com/netdiag/<br />
  28. 28. まとめ<br />ドキュメントはちゃんと更新しましょう<br />diagシリーズがおすすめです。<br />blockdiag, seqdiag, actdiag, netdiagでググってね<br />ネットワーク屋さん向け? に netdiagを作ったよ<br />もちろん Sphinx もおすすめです。<br />

×