ドキュメント読み

ドキュメントは大抵の場合において読まれないものである。分からないことがあったら、索引とか目次を調べて分からないところだけを読むくらい。使う分にはそれほど不自由しなければそれで終わる。

という不遇な末路をたどるドキュメントをちゃんと読んであげようというキャンペーン(嘘)。ちゃんと一から読むと、今まで知らなかった便利な機能とか設計思想とか分かるのではないかという幻想を持ってみる。ちと前にCode Readingが話題になったけど、これはそれの一歩手前。

とはいえ、自分で一から読むのはやっぱり面倒。脳内で神様(悪魔?)が囁く「自分がイヤなら、人にやらせればいいじゃない」。ということで、来期の計算数学I/IIで「ドキュメントを読む」という課題を受講生にさせてみてもいいかなと思った。

受講生は授業が始まったらひたすらにドキュメントを読む。読んで理解したことを毎回まとめる。ドキュメントを「読む」だけなので、特別なスキルとかは一切必要なし(逆にないほうが変な偏見がない分いいかもしれない)。最終的な成果物としては、読んで理解したこと(あまり知られてはなさそうだけど知ってると便利な機能とか)、ドキュメントを読んで気づいた点などをまとめてもらったものを提出。

問題としては実際のソフトを触らせるかどうか。あくまで「読む」ことが目的なのでソフトに触らせる必要がないというのは最もなのだが、ソフトを触らせながら読んだほうが書いてあることの理解が早まりそうな気もする。でもそれを許すとソフトばっかり触りそうな気が…。ドキュメントを読み続けるのは多少なりとも辛いだろうし。

まあ、そういう苦しい作業を単位という餌で釣ってやらせるわけだからやはり触らせないほうがいい気がしてきた。必要ならば最後の何回かで実践させればいいわけだし、あるいは家で実践できるものであれば実践はそっちでやってもらって授業のときはひたすらに読むことに専念してもらうとか。(ドキュメント読み=苦行という前提がそもそも間違ってる?)

特別なスキルがいらないのであれば計算数学じゃなくて前期過程の全学ゼミナールに回してもいい気がする…って一昨年の「The UNIX Programming Environment」を読ませる話はそういう目的だったのではないかという気がしてきた。あれは結局触れさせることに重きを置いてたけど。

後は読ませる価値のありそうなドキュメントを選別することかな。まあダメなドキュメントでも何がダメなのかを指摘すれば、課題としては十分だと思うのだけど、なるべくなら読んでためになるものを読ませたいというか、それをまとめてくれると、こちらが助かるようなものを読んでもらいたいというか…

カテゴリー: ks. ドキュメント読み はコメントを受け付けていません。
%d人のブロガーが「いいね」をつけました。