パスワードを忘れた? アカウント作成
この議論は賞味期限が切れたので、アーカイブ化されています。 新たにコメントを付けることはできません。

プログラマーにドキュメントを書かせるには?」記事へのコメント

  • ドキュメントの質の基準を明確にする
    基準に基づいて評価する
    評価にインセンティブを与える

    • by Anonymous Coward

      読み手のレベルが確定しないと書けないってのはありますね。
      こっちにとって当たり前のキーワードが不明だと質問されても
      それぐらい常識だろ、としか返せない。

      あとこっちもシステム全体の仕様のサブセットをコーディングしているだけなのに、
      そもそものシステムの思想なぞ求められても困ります。

      私は、未来の自分宛の読み物として書くことが多いですね。
      全体の把握のための概論と、あとはおおむね苦労話を「読み物」として。
      細かい動作はコードを見ろという方針、現在の自分がひっかっかった所は
      未来の自分もまたひっかか

      • 話は変わりますが、ソースコードを開いた先頭に、「このソースは何をする
        (つもりの)ものである」と一行でいいから書いてくれんかなぁ。追いかける時の
        安心度が違うのよ。

        ライセンス込みでコピペして修正し忘れそうだけど。

        コードしかメンテせずに、知っててコメントを古いまま放置するやつもいる。

        「何をする」つもりで作り始めたけど、作っているうちにもっといい方法を思いついたので方針を転換した
          → 初期のコメントは放置
        なんてのもある。

        全部おれのコードだ。

        親コメント

犯人はmoriwaka -- Anonymous Coward

処理中...