タグ

ドキュメントとエンジニアに関するtakamR1のブックマーク (5)

  • 文章に向いてない構造をいかに文章に向いた構造に直列化するかが大事 - きしだのHatena

    Software Design 12月号の特集が「なぜエンジニアは文章が下手なのか?」というタイトルだったので、読んでみたら、ちょっと残念な内容だった。 「それは文章で書くべき情報なのか」という章があって、直列化した論理構造であれば文章には書きやすいけど、分岐やループがあるような構造だと書きにくいということが書いてあった。そこで文章化しにくい構造の例として地図があげてあって、暗にそういう構造は文章化をやめて図であらわせと言っているように読める。 けれども、図に書いたところで、書く側は文章化から逃げれて満足かもしれないけど、それを読み取る側は結局どこかから順番に解釈していく必要がある。図に逃げるのは、読み手に責任を押し付けているだけだと思う。 で、「ですから文章を書く前にまず論理構造を考える必要があります」と続いていて、では考えた論理構造が「文章に向かない論理構造」だったらどうするの?逃げる

    文章に向いてない構造をいかに文章に向いた構造に直列化するかが大事 - きしだのHatena
    takamR1
    takamR1 2012/11/25
    USDMの要求の書き方、構造化に通じるものがあるな
  • どうして開発者がドキュメントを書くべきか - 2011-10-27 - ククログ

    オフィス文書形式が要求されるようなドキュメントではなくて、自分が開発したライブラリのドキュメント(リファレンスマニュアルやチュートリアルなどライブラリのユーザーが読むためのドキュメント)の話です。以下の「ドキュメント」もそのような意味で使っています。 使いやすいライブラリを開発したかったらプログラムだけではなくドキュメントも書くべきです。 なぜドキュメントを書くか ドキュメントを書く習慣があるかどうかは開発者によってあったりなかったりです。使っているプログラミング言語に相関がある気もしますし、リリースするかどうかに相関がある気もします。理由はいろいろあるでしょうが、ドキュメントを書く習慣のない開発者の方が多いでしょう。 書かない理由はこんな感じでしょうか。 面倒。 自分しか使わないからいらない。 どのように書けばよいかわからない。(どのツールを使えばよいかわからない。) 一方、書く理由はこ

    どうして開発者がドキュメントを書くべきか - 2011-10-27 - ククログ
  • 書き手だけが知っている - rabbit2goのブログ

    セミナーや人の話を聞いて新しい知識を学んだ時には、その感想とかコメントを簡単にまとめて記録に残すようにしている(ブログに載せている情報もその一例だ)。また、会議や講演のように後から情報を読み直せないものは、話の内容を延々とメモした上で、それを振り返りつつ要点をまとめるようにしている。読書の感想文、出張報告書とか、開発プロジェクト報告書なども同じで、手間と時間はかかるけど必ず文章という形で保存している。 私見だけど、他人の話でもそれを自分でノートに取ることで記憶に刻み込まれ、より理解が深まるように思う。1時間にも及ぶ話を聞いて理解するのは簡単だけど、その内容を全部覚えるのは大変だ。その直後なら話の印象が残っているのでアレコレと感想を言えても、1週間経って同じ話を出来る人はそう多くないだろう。だからこそ、話の内容をメモにとって確実に記憶へ残す手続きが必要になるのだ。自分の手を動かしてノートを取

    書き手だけが知っている - rabbit2goのブログ
  • それは説明責任の問題 - rabbit2goのブログ

    ソフトウェア開発者の仕事は、もちろん納期通りに要求されたソフトウェアを開発することだけど、それだけではない。成果物に対する説明責任も伴うはずだ。 どのようなアーキテクチャ、デザインパターンを採用しているのか? モジュール構成、クラス構成はどうなっているのか? 何をどのようにテストすれば良いのか? 性能面、機能面でのボトルネックはどこか? どのような障害が発生したのか? 次の派生開発時に改善すべき問題は何か? 通常、これらの情報は仕様書などの資料として残したり、申し送り事項という形で整理されるはずだ。もちろん、ソースコードを読めば分かるようなことはどうでも良くて、そのコードの背景にある設計思想とか、大量のコードの中に埋もれがちな考え方、役立った開発資料などの情報の方がずっと重要な意味を持っていたりする。こんな情報こそ整理しておく価値があると思う。 しかしながら、開発が終わって一安心するのか、

    それは説明責任の問題 - rabbit2goのブログ
    takamR1
    takamR1 2011/05/17
    自分で説明できないコードを1行たりとも書くな!
  • 『見習いプログラマ(中略)10冊』を書いた理由と、更に読んで欲しい5冊 : ソースコードは飲み物です。

    2010-11-28 04:26:00 GMT (※)このエントリは『見習いプログラマが読んだら、すぐにジョブレベルが上がる10冊』の補足になります。 (1)前回のエントリを書いた理由 (2)頂いたご意見に対して (3)更に読んで欲しい5冊 の順に書きたいと思います。 『戯言はいいからだけ教えれ』という方は下のほうの(3)へ (1)前回のエントリを書いた理由 僕がプログラミングを最初に学んだ頃(まだテレホーダイの時代) プログラミングを学ぶのにどのが良いかなんて情報がさっぱりありませんでした。 手当たり次第に買うしかありませんでした。 #当時は『大人のCGIスクリプト』を書名に惹かれて買い、ログファイルが飛ばないカウンタ・掲示板の作り方を見て感動していました。 #ログファイルを二重に用意し、更新日時が新しいほうを読み出し、内容を変更・追加し、更新日時が古いほう上書きするとい

  • 1