タグ

開発とsphinxに関するp260-2001fpのブックマーク (4)

  • ドキュメンテーションを加速するストレスフリーの作図ツール『blockdiag』 jus2011年6月勉強会

    システム開発や保守、運用の現場においてドキュメントは必須のものです。 しかし、ドキュメントの作成・維持には多くのパワーがかかるため、ドキュ メントが存在しない、資料が古いままになっているなどといった現状を多く 耳にします。 勉強会ではこれらのドキュメントでよく利用される「図」にフォーカスし、 みるみるうちに図を作成できる「blockdiag」をご紹介します。 「blockdiag」はシンプルなテキスト記述からブロック図、ネットワーク図などの 画像ファイルを出力可能なオープンソースの画像生成ツールです。書き やすさ、メンテナンスしやすさを中心にデザインされており、図を作るのに 配置や並べ替えに苦労する必要はありません。 blockdiagのサンプルはこちら このような特徴を持つ「blockdiag」と、シンプルな記述でドキュメントを作成 するツール「Sphinx」を組み合わせることによって

    ドキュメンテーションを加速するストレスフリーの作図ツール『blockdiag』 jus2011年6月勉強会
    p260-2001fp
    p260-2001fp 2011/06/19
    blockdiagどんどん成長してる。すごいなー。ただSphinxも含めてWYSIWYGエディタがないと普及は…(TracからRedmineに移行できない理由の一つ)
  • Shibu's Diary: Sphinxについていろいろ考え中・・・

    渋日記@shibu.jp 渋川よしきの日記です。ソフトウェア開発とか、ライフハックを中心に記事を書いていきます。 Sphinxについていろいろ考え中です。ツールとしてのすばらしさは申し分なく、いろいろ夢が広がりすぎて困ってしまうぐらいです。悩んでいるテーマは2つ。 Sphinx hack-a-thon @aohtaから、公式ハッシュタグについてのアナウンスもあった、Sphinx hack-a-thon。偶然、同日に同じ会場でやることになっている、Python hack-a-thonと共同開催です。やる内容はこんな感じかな、と思っています。 ハンズオン Sphinxをインストールしてみて、料理レシピか何かのドキュメントを作ってみよう!という30分~50分程度のハンズオン。参考資料は↓このあたり。手前味噌だけど。@MiCHiLUがPDF出力とか説明してくれたりするかな!? Sphinxドキュ

  • Shibu's Diary: とちぎRuby会議02 - その2(LTディレクターズカット版)

    渋日記@shibu.jp 渋川よしきの日記です。ソフトウェア開発とか、ライフハックを中心に記事を書いていきます。 前回のエントリーでは、とちぎRuby会議02で発表した資料を公開したのですが、時間の都合でカットした分を公開します。死蔵しても意味ないしね。まさにディレクターズカット版です。というか、カットした部分だけ。どちらかというと、文章の書き方渋川流メソッドなので、内容的にはこちらの方が「儲かるRuby」という今回のテーマには近い気がしたけど、どうしてもアジャイルについて入れたかったのと、江渡さん栃木上陸記念を入れたかったので、こちらをカットしました。イテレーティブなドキュメンテーションとかの話しはここでの話しを飛ばしてしまうと、編で唐突な印象だったんじゃないかな、とは思いますが・・・ 儲かるドキュメントを書く場合に、何をどう書いていけばいいのか、という話しをします。まだ考え中の部分な

    p260-2001fp
    p260-2001fp 2009/10/26
    『開発を加速させるドキュメンテーション』『文章も コードと一緒 イテレーション』会話、チャット等一度アウトプットしてから文章に落とす。『コードにはHowを、テストにはWhatを』
  • Shibu's Diary: とちぎRuby会議02 - その1(LT)

    渋日記@shibu.jp 渋川よしきの日記です。ソフトウェア開発とか、ライフハックを中心に記事を書いていきます。 とちぎRuby会議02がありました!普段は技術や「普及するには?」ということについて語られることが多いIT系イベントですが、仕事としてのマインドについて多くのメッセージを聞くことができました。今回はその中でLTの発表をしてきましたので、スライドとスクリプト(時間の関係でかなり削りましたが)を公開します。裏切り者感たっぷりのスライドですが、最後までおつきあいください。 今回ご紹介したいものが、このSphinxです。 Wikiみたいなプレーンテキストの簡易マークアップから整形してくれるツールです。相互リンクも張ったり、索引を作ったりもしてくれる。LaTeXを経由しないPDF出力は現在活発に開発されている部分。これができるとかなり強力です。コードハイライトも、nginxというリバース

    p260-2001fp
    p260-2001fp 2009/10/26
    WikiとSphinxの比較、『Sphinxはドキュメント界のSUnitになれるのでは』『文芸的ユニットテスト』Sphinxは手書きのドキュメントと、自動作成のドキュメントを融合させるために作られた。
  • 1