バスレフ研究所 Personal Audio Laboratory mcap.exblog.jp

工学オーディオに取組むオカルト嫌いです。


by MCAP-CR
プロフィールを見る
画像一覧

ソフトウェアのドキュメント

多自由度バスレフ研究所のサイトで配布している解析プログラムは、2015年からは更新されていませんが、いずれまた機能の追加を試みるかもしれません。
今のところは、グラフィックスはまだまだ4階料の余地があるものの、解析プログラム自体は結構うまくできているのではないかと思います。
配布しているバージョンごとに、ソフトウェアのドキュメントとプログラムのソースコードを含めてはいます。
配布ソフトに添付されているドキュメントは、ソフトウェアを使用するという目的で作成されており、通常のソフトウェアであればこれで十分なのですが、次回の機能追加のために、自分でわかるようにしておかなければならないと考えています。

随分前に、ドキュメントを書く、とこのブログに書きましたが、まだできていません。
少しずつ追加していますが、どのように書けば、後でも分かるのか試行錯誤するのに、頭を使います。
プログラムには、書いているうちに何だかわからなくなるのを防止するために、コメントを記入してあります。
自分のプログラムの場合には、コメントがかなりの分量を占めており、書いた自分ならある程度付いていけるので、これでもいいような気がしますが、やっぱり、これでは、よくわからないのだろうと思います。
以前には、フローチャートを作成するのを断念したこともあります。
職業プログラマではない自分には、指導者がいないので、自己流でやっています。
下を見ればきりがありませんが、上を目指してなんとかドキュメントを完成させたいと思っています。


[PR]
トラックバックURL : http://mcap.exblog.jp/tb/238046564
トラックバックする(会員専用) [ヘルプ]
Commented by hiro-osawa at 2017-12-06 04:12
昔他人の書いたプログラムのフロー構造資料、ドキュメントを作ってもらいたいとの依頼が来たことありました。
納入先から、まるで内容理解できないのでわかるようにしろとのクレームだったらしいです。作った本人は最後っ屁で転職してしまったので後の祭りです。もちろんそんな仕事うけられるはずがありません。また後から誰かにやらせれば済むと思ってるのは認識すらない証拠でした。こんなこと当時の民営化したばかりの電話会社がらみで、程度の低いことでした。
Commented by mcap-cr at 2017-12-06 06:39
> hiro-osawaさん
仕事でのプログラミングはやっつけ仕事になりがちなのかもしれません。
逆に大学の研究室とかでは、アルゴリズム部分は、明確にしていたりするのかもしれません。
プログラミングを一人に任せると、サポートできなくなるので、本来やってはいけなかったことなのかもしれません。
1人でのプロジェクトは、ソフトウェアにドキュメントを添付させて、検収時にチェックすればよいのでしょうね。
by mcap-cr | 2017-12-05 23:59 | プログラミング | Trackback | Comments(2)