[B! document] shirebitoのブックマーク

shirebito id:shirebito

documentに関するshirebitoのブックマーク (3)

Sphinxでmscgen / graphviz | Go for it!
Sphinxでドキュメントを書いたりしています。以前からシーケンス図やブロック図を描くのにそれぞれ mscgen や graphviz といったツールを使っています。これらのソフトウェアは、テキスト形式で定義を記述する（dot形式というらしい）と画像を生成してくれます。単純に画像を作るだけならMicrosoft VisioやOmniGraffleでいいのですが、テキストベースでドキュメントを書いている場合、いろんなアプリケーションを横断しなくてはならず、ちょっと面倒なんですよね。 mscgenやgraphvizを使えばテキストファイルのみで管理することができるというわけです。で、本題。 Sphinxにはこれらの拡張が用意されています（標準ではないです）。拡張を導入することでSphinxドキュメント内にdot記述をすることが出来るようになります。 http://package
shirebito 2011/05/25
python

document
リンク
sphinx + blockdiagがとっても最強すぎる件 - 猫型開発者
Yokohama.pmで @tk0miya さんが発表していた sphinx + blockdiag。 sphinxはテキストファイルをWiki記法みたいな書き方で書いてmakeするだけでhtmlとかpdfを生成してくれる魔法のツール。pythonで書かれてる。 blockdiagはテキストファイルから遷移図とかシーケンス図とかネットワーク図とかを生成できるツールで、sphinxのreSTファイル内に埋め込むことができる。コードに対するドキュメントなどはコードに埋め込んじゃえばいいんだけど(pod,javadoc、いろいろあるよね)、設計に関するドキュメントだとか運用に関するドキュメントは別に書かないといけなくて、ついつい後回しにして、必要になった時には後の祭り…なんてことが結構ある。かと言って、開発初期とプロダクトが成熟してきたときでは仕様に結構な差があったりして、初期に書いたドキュメ
shirebito 2011/05/22
python

document
リンク
本当のドキュメントと向き合えますか | Webシステム開発／教育ソリューションのタイムインターメディア
「本当のドキュメントと向き合えますか」というタイトルで qpstudy で話してきました。 3分LT という超短い時間だったので駆け足での発表になりましたが、インフラエンジニアの方もドキュメントは悩みの種なのか、blockdiag を気に入ってくれた方がいるようです。また、この発表に合わせて作った netdiag も悪い感触ではなかったようなので、これから作り込んでいこうかと思います。
shirebito 2011/05/14
document
リンク
1