[ruby-list:36004] WeRDS (the Weekly Ruby-Doc Summary) 2002-09-22

すぎむし%くどいようですが、うるさければ謹慎しますので。
その他なんでも、ご意見あれば下さい。

ruby-docメイリングリスト、先週末までのサマリです。

[ruby-doc:00148] WeRDS, the Weekly Ruby-Doc Summary, for 2002-09-22

2002年09月22日時点のWeRDS (the Weekly Ruby-Doc Summary) です。
今週は(も)James Brittがお届けします。(日本語訳: すぎむし)

    主なスレッド(Threads)
    =====================

    ドキュメントを、オブジェクトとして?

        Hugh Sasse氏が、「ドキュメントはオブジェクトだ」という
        アプローチを提案した。クライアントのコードから、
        SomeObject::Documentation.some_method と呼び出しできる
        ようにしよう、というわけだ。Jim Freeze氏は、RDocが、
        このクラスを自動生成してくれたらいいのに、と示唆を与えた。


    ドキュメントはコード埋め込み? それとも別ファイル?

        James Britt氏が、ドキュメントは「文芸的プログラミング」
        (木村泉氏訳)[註0]風に、コードと一体で番をする方が好きだ、
        なにもかも別々のファイルにしまいこんでしまうのはごめんだ、
        と意見した。これには議論が続いて、それぞれを比べたときの
        得失と、開発者にとってドキュメント作成をできるだけ面倒で
        なくするには、という話になった。
    [0] http://www.literateprogramming.com/


    一口にドキュメントっていうけれど

        スレッドがもう一本、枝分かれした。こちらの話の焦点は、
        APIのドキュメントとアプリケイションのドキュメントの違い
        であった。


    XMLの果たせるもの

        Sean Chittenden氏は、rubydoc[1]のツールとして既に
        あるもの・提案するものが、いかに簡便かを説明した。
        その特徴の核となるのがXMLであり、続く議論では、XMLが
        どのように、なぜ、どういった場面で、活用できるのか、
        もしくはするべきであるのか、が論じられた。
    [1] http://www.rubydoc.org


    ユースケイスで、われわれはどんな恵みを受けたか、そして
    なにがもたらされたか?

        James Britt氏は、正しく取り上げられた問題が一番よい
        解決を見られるように、ユースケイス(あるいは似たよな
        もの)が、プロジェクトの要求にピントを合わせるのに
        役立つようなものかどうかを知りたがった。Albert
        Wagner氏が、どこまでも続く枝別れの多い一連のポストを
        追いかけていって混乱したと告白した。Jim Freeze氏は、
        要求事項文書のヴァージョン2に向け作業中だと述べた。


    内省的ドキュメント化

        Rubyのリフレクション機能をどう活かすか、というアイディアが
        流れた。Booker Bense氏は、「ソースがドキュメントだ」という
        哲学に従いたい、と述べた。


はい、今週はここまで!