タグ

ブックマーク / dev.ariel-networks.com (1)

  • 「Emacsのトラノマキ」連載第17回「怠惰なプログラマのためのドキュメント作成実践」(佐藤寛之) | ありえるえりあ

    ■■■怠惰なプログラマのためのドキュメント作成実践 ■■はじめに ソフトウェア開発においてドキュメントは欠くことのできない重要なものです。ドキュメントと聞くと、キングファイルに綴じられた分厚い紙束を連想してうんざりする方も多いかと思います(筆者もそうです)。一口にドキュメントと言っても多種多様ですが、その質は書き手と読み手のコミュニケーションの手段です。したがって、読む気の起きないドキュメントや誰も読まないドキュメントは来の目的を達していないことになります。 ■ドキュメントのあり方の変遷 ドキュメントのあり方は、技術の進歩や文化の変遷によって変わり続けています。身近な例として、携帯電話のマニュアルがあります。 筆者が携帯電話を使い始めたのは十数年前になりますが、機能やサービスの増加に伴ってマニュアルは年々分厚くなってきました。もちろん必要性があってのことですが、読む気が失せるのも正直な

  • 1