タグ

programmingとdocumentationに関するtsupoのブックマーク (4)

  • [論点3]どんな開発手法を適用すべきか

    みずほ証券がテストの件に加えてもう一つ、東証の重過失に当たるとしたのが「システムの開発手法が適切ではなかった」点だ。開発ベンダーに適切な開発手法を求めなかったため、発注者である東証も責任を免れないとする。 開発手法が適切ではないことを説明するために、みずほ証券は具体的な事例を示した。東証がソースコードを修正する際に、「モジュール詳細定義」などのドキュメントを修正していなかった点だ。 東証はこの事実を認めた上で、「一旦コーディングが済めば、その後の修正は、全てソースコードを中心に行うことが最も効率的であるから、モジュール詳細定義を改訂していなかったことに問題はない」と反論した。「コーディングが済めば、ソースコード自体が、最も詳細なドキュメントである」というわけだ。 これに対してみずほ証券は、ソフトウエア工学の専門家による意見書を引用し、こうした東証の主張を真っ向から否定した。「システムを保守

    [論点3]どんな開発手法を適用すべきか
    tsupo
    tsupo 2013/04/04
    ソースコードを修正したら、それをドキュメントに反映すべきか否か / 重複コードが多いと潜在バグも多くなる vs 信頼性が高くなる // おそらく、ドキュメントの修正にはいちいち決裁が必要な開発体制だと思われる
  • ricollab Web Tech Blog » Blog Archive » はてなダイアリーAtomPubレビュー: その2 ドキュメンテーション編

    その1を公開してからだいぶ時間が経ってしまいましたが、その2を公開します。今回はドキュメンテーション編です。 レビュー対象ははてなダイアリーAtomPubの仕様書です。普段私が業務で仕様書をレビューするときに気をつけている観点をご紹介しながら、いくつか指摘をしてみます。 なお、レビューの指摘はどうしても細かくなってしまうので、粗探し的と感じられてしまうかもしれませんが、技術的な完成度を上げるためには必要な作業なのでご容赦ください。 基的な文章チェック まず、仕様書に記述されている文章の「てにをは」や文法レベルでのチェックをします。表記ゆれなども含まれます。 今回の仕様書は、たとえば以下のような記述がありました。 「ヘッダ」と「ヘッダー」、「XML文書」と「XML文章」、「はてなID」と「はてなアカウントのid」などの表記ゆれ。document に対する訳語は通常は「文書」を用います 「~

    tsupo
    tsupo 2008/11/17
    ソースコードレビューと同じくらいドキュメントのレビューにも力を入れるべき / ライティングスキルもプログラミングスキルと同じくらい重要である → 「ソースを先に書くか、ドキュメントを先に書くか」問題も!!
  • DoxygenとGraphvizでの日本語の使用について - だらろぐ

    Doxygen用コメント内に@dotコマンドで図を埋め込む場合、日語を使うには、過去にはdoxygenを改造するなどいろいろと工夫が必要だったようですが、最近のバージョンでは、いくらか制限はありますが一応そのまま使えるようです。 私が使用しているバージョンは以下の通り。 Doxygen: 1.5.4 Graphviz: 2.16.1 日語を扱うための条件は以下の通り。 ソースの文字コードがUTF-8であること。 fontname属性で日フォント("MS Gothic"など)を指定すること。古いバージョンではフォントファイル名で指定していたようですが、最近のバージョンではフォント名で指定します。 フォント名に全角文字を使っているフォントは指定できないようです。 別記事に続きがあります。

    DoxygenとGraphvizでの日本語の使用について - だらろぐ
    tsupo
    tsupo 2008/03/12
    最近の Doxygen は UTF-8 が通るようになったので、むかしほど苦労しなくてよくなった。Graphviz のフォント指定に関しては、まだ癖が残っている。自分の過去記事へのフォローアップ、書いとかないといけないな
  • 人気のAPI/フレームワークを作るための39カ条

    ある仕様を利用するための網羅性の高いライブラリを用意したいとき 再利用性が高い(と思われる)プログラムをライブラリ化したいとき Webシステムを外部から利用してもらうために一部分を公開したい場合 多人数で開発する事柄で共通化させておきたい部分をまとめたい場合 ほかの言語で作られたアプリケーションをある言語で利用したいときの橋渡し用 ちなみに、JSP/Servletの世界でよく使われているStruts Frameworkは開発者のCraig McClanahan氏が休暇中に思い付いて開発したものだそうです。オレゴン州のビーチで、ラップトップに向かい、3日間の休暇中ずっとコーディングしていたそうです。 一緒に行った奥さんは機嫌が悪かったようですけど。 ここでは、作成したAPIが自分だけではなく、多くの人に使ってもらえるよう、便利に使えるポイント、広く普及するためのポイントをとらえていきましょう

    人気のAPI/フレームワークを作るための39カ条
    tsupo
    tsupo 2007/07/23
    大抵の場合、ドキュメントの充実度は、APIそれ自身の完成度にも大きくかかわってきます → 実際、ドキュメントが貧弱すぎて、(開発当初からコミットしている人以外には)使い方がさっぱりわからないのもあるし。
  • 1