スポンサーリンク

T.Ishii's Software Library

HTML5 レトロ風ゲーム館

無料ブログはココログ

« ジワジワと増殖中 | トップページ | ほぼ良い感じだが »

大体は書けた様な気がする

今は、Mirror-DTCのシェアウェア化を行うフェーズで、今週リリースする予定になっているのだが、最後の仕上げとして行っていた操作説明用のドキュメントも、今日の時点で大体は書けた様な気がしている。「気がしている」、って? と、思う人もいるかもしれないのだが。

その筋の人なら聞いた事がある筈なのだが、大昔から、コンピュータ関連の仕様書なんてモノには、どれだけ頑張っても、30%程度の仕様しか記述できない、という事になっている。

例えば、void func(int a) みたいな関数の入出力仕様としては、入力がint型変数一つで出力はない、と、記述すれば、普通はそれで良いかもしれないのだが、例えば、入力がint型ではなくunsigned int型だった場合、どういう振る舞いをするのか、だとかについては、その仕様書には記載されない訳だ。

何故、記述されないのか、というと、そんな話は上記の関数に限った話ではないし、どうなるのか、なんてのは常識だからでもあるのだが、実際の所としては、そんな事まで記述していると、仕様書が広辞苑みたいになってしまうから、でもある訳だ。

と、いう事で、通常、ドキュメントには、全てが書かれる訳ではないので、そのドキュメントが読まれる時には、読み手の力量が問われる事になる訳だ。

逆に言うと、読み手の力量が高い事を想定する場合には、ドキュメントには必要最低限の情報のみ載せれば良い事になるし、低い事を想定する場合には、常識的な話も含めて、必須でもない情報も、載せなければならなくなる訳だ。

なので、同じ操作説明書でも、書き方は一通りではない訳なので、書き上げてしまっても、これで良いのかなあ、と、思ったりもしてしまう訳だ。

このため、作者的には、現状では、書けた様な「気がしている」訳なのだが、このブログを良く見ている人なら、作者が良く、「木を見て森を見ず」、という諺を使っているのを知っているかもしれない。

作者がこの諺を良く使うのは、作者自身が、若い頃には、よく、こんな感じの愚行をやらかしたりしたからだ。

つまり、例えば、目先の作業ばかり気にして、その目的を意識していないと、いくら頑張って作業しても、事態は好転しないばかりか悪化したりもする訳だ。

なので、そういう事にならない様に、作業というのは、まず、その必要性を鑑みて過不足なく行える様に計画を立ててから行うのが望ましい訳なのだが、森というのは木の集合体だったりもする訳だ。

つまり、木が無いと森も見えてこない場合もある訳だ。

と、いう事で、個別の操作説明書なんてモノは、上記の木にしかならないのだが、それらが合わされば、森になってくれるかもしれない。

まあ、実際には、操作説明書だけでは全然足りないので、既に、このブログに色々と書いてきたリもしているし、リリース時に書く事になる筈のリリース記事にも、もう少し大きな話は書く事になる筈だ。

今回書いた操作説明書というのは、それらと一緒に、森を形成する事になる筈なのだが、実際の所、README.txtすら読まない人には、そんな事は無関係な訳だ。

なので、また、「私は初心者で、何が書いてあるのか全然判らないので、もっとチャンと説明して下さい」、なんてメールを受け取る事になるかもしれないのだが、そういう人は、作者にメールを送る前に、以下のリンクを読んでみるのが良いかもしれない。

自称初心者

自称初心者とは?

自称初心者の誤った謙遜は伸びの鈍化を招き相手に迷惑をかける

上記は、今日、Googleで、「自称初心者」を検索すると出てきたページの幾つかになるのだが、上記を読めば判る様に、少なくともIT業界では、自称初心者は軽蔑されていて、自分は初心者だと言うだけで、相手を怒らせ、マトモに対応してもらえなくなる場合も多い訳だ。

少なくとも、上記の記事を書いている様な人達は、そんな感じなので、私は初心者なんだからもっと丁寧に教えろ、なんて事を言った日には、激怒される可能性もあるかもしれない。

そして、特に、Mirror-DTCというソフトは、その基本機能からして、初心者お断りな所もある訳なので、作者の所にも、間違っても、上記の様なメールは送らない様にした方が良いかもしれない。

« ジワジワと増殖中 | トップページ | ほぼ良い感じだが »

トラックバック


この記事へのトラックバック一覧です: 大体は書けた様な気がする:

« ジワジワと増殖中 | トップページ | ほぼ良い感じだが »

2019年9月
1 2 3 4 5 6 7
8 9 10 11 12 13 14
15 16 17 18 19 20 21
22 23 24 25 26 27 28
29 30          

広告

プライバシーポリシー

  • 当サイトでは、第三者配信による広告(Google Adsense)サービスを利用しています。

    Google を含む第三者配信事業者は、Cookie を使用して、ユーザーのウェブサイトでの閲覧履歴に基づく広告を配信します。 Google 広告 Cookie を使用することにより、Google や Google のパートナーは当サイトや他のサイトへのアクセス情報に基づく広告をユーザーに表示できます。

    収集された情報がGoogleによってどの様に使用されるか、収集される情報をユーザーが管理する方法については、以下のリンクを参照下さい。

    ポリシーと規約 - Google