自分が作ったプログラムを、他の人も楽しめるように公開することは 大きな価値がある。少しでも楽しんでもらえるよう、わかりやすく 説明したい。
初めて使う人が混乱しない操作方法になるよう設計する。ただし あまりにお節介な操作画面だと慣れてからまどろっこしく感じてしまい 使いづらい。このあたりのバランスを良く考える。利用者がプログラムを 使うときの操作性のことをユーザインタフェース(UI)という。
プログラムの中味については、あとで自分が読んで分かりやすいようにする。
どこで何をしているかのコメントをしっかりと残しておく(コメントは
#記号の後に書く)。
作成したプログラムが何をするものか、どのように起動するか、どのように 操作するかを書いた説明書をしっかりと書く。説明書は以下の二種類を作成する と良いだろう。
ここでは、架空のプログラム「NumberMagiQ」の説明書を書く場合 を例に示そう。