|
|
||
| 先日「ソフトを公開したいのだが、Readme
の書き方がわからない」というメールをいただきました。プログラミングが終了した後
Readme
を書く、ヘルプを作る、インストーラを用意するなどの副次的な作業は、なかなか面倒です。プログラミングのおまけみたいで、つい手を抜いてしまいがちですが、ユーザーにソフトを理解してもらうためにも頑張って作りあげる必要があります。中でもReadme
は、作者からユーザーへ送る最初のメッセージとしてなくてはならないものです。 Readme は何を書けば良いのでしょう？ Readme は作者によって様々に書かれています。特にどう書かなければいけないという決まりはないように見えます。基本的には、作者が書きたいように書けばいいでしょう。ただ気をつけたいのは、「自分が他人のソフトを使うときに知りたいこと」だけはかならず書いておくということです（自分が知りたいことは、やはりユーザーも知りたいはずですから）。 そう考えると、よく書いてある作者の開発環境やマシンスペックなどは、ユーザーが自分の環境でソフトを使うことができるかどうかの判断材料にはなりますが、特になくても大丈夫なものかもしれません。 具体的なサンプルがないとわからないと言う場合のアドバイスです。 様々のソフトに添付されている Readme を参考にして、自分用に雛形を作ってみてください。一度作ってしまえば、次からはずいぶん楽になるはずです。手を加えながら良いものにしていってください。 他に気をつけたい点は、 ・書く文章の行幅をあまり長くしない（メモ帳のサイズを変えなくても読めるように！）。 ・開発履歴はしつこく書かない（ユーザーは興味を持たない！）。 ・ユーザーはPCに詳しくない、を前提にする（ユーザーに親切に！）。 ・ユーザーはソフトを初めて見る事を忘れない（ソフトを知っているのは作者だけ！）。 などなど。 皆さんもソフト作りを楽しんで、ぜひ Readme を書く機会を持ってくださいね（2005/01/23）。 |