- 1 名前：デフォルトの名無しさん [03/10/05 23:34]
- おまえら、自分で作ったプログラムについての、わかりやすく的確な
ドキュメントを書ける自信はあるか？
仕事で納品したり、他人に見せるプログラムとして公開するつもりなら、
マニュアルや、仕様書などのドキュメントを書く機会は必ずある。
プログラムとドキュメントはとても関係が深い。ドキュメントが整っていない
プログラムなど、ゴミと同じ。それに、ただ書けばいいって物でもない。
ドキュメントがゴミ程の役にも立たなければ、結局それはゴミなのだ。
だらだらと書いた意味不明な文章を他人に見られるのも恥ずかしいよな？
いわばドキュメントを書く技術はプログラマの必須スキルの１つなのだが、
実際は、下手糞なドキュメントが蔓延っている。(これはGNU製に多い)
読んでも無駄とか、書いても無駄とか思ってる奴、その考えを改めろ。
プログラムに対するドキュメントを、ちゃんとした１作品として、
後世に残せるよう努力すべきだろう。
今一度問う。
おまえら、わかりやすく的確なドキュメントを書ける自信はあるか？
- 487 名前：デフォルトの名無しさん [2007/10/28(日) 13:23:14 ]
- よく、日本人は罫線をやたらと使いたがるって話があって、
たしかに、excelで、罫線使いまくったドキュメントって書くのが面倒なんだけど、
かといって、日本式のそういうドキュメントしか見たことないから、罫線なしで
かっこいいドキュメントというのが想像できません。
外国で使われてるドキュメントのサンプルみたいのを見れるところってありませんかね。
- 488 名前：デフォルトの名無しさん mailto:sage [2007/10/28(日) 20:18:16 ]
- >>487
米のミドルウェアをいくつも使ったけど、そのへんのオープンソースのよりもショボい感じ。
オープンソースのをいくつも見ればいいと思うよ。
- 489 名前：デフォルトの名無しさん mailto:sage [2007/10/29(月) 01:30:01 ]
- HTMLヘルプで十分て気がする
表示ソフトいらないし、ファイル1個で済むし
*NIXで見れない？
知 る か
- 490 名前：デフォルトの名無しさん mailto:sage [2007/10/29(月) 02:08:39 ]
- >489
つttp://xchm.sourceforge.net/
- 491 名前：デフォルトの名無しさん mailto:sage [2007/10/29(月) 12:29:28 ]
- >>487
罫線を使わないこととExcelを使わないことはイコールではないよ。
喩えて言えば、○×をやるのに周りを囲むか(囲こんな形)か、囲まないか(井こんな形)の違い。
- 492 名前：デフォルトの名無しさん mailto:sage [2007/12/08(土) 03:09:44 ]
- doxygenで更新履歴をいじった関数に書いて、
todoリストみたいにまとめたいなと思って調べたら、
\xrefitemを使えばオリジナルの\todoができることは、わかったのですが、
関連ページ追加される項目を日付ごとにまとめて並べること方法ないでしょうか?
- 493 名前：492 mailto:sage [2007/12/10(月) 02:14:40 ]
- 以下のようにしてみました。
ALIASES += "history{1}=\xrefitem histories\1 \"更新履歴(\1)\" \"更新履歴(\1)\""
日付でソートできていないし、日付ごとに別ファイルになってしまいます。orz
もっとよい方法は無いでしょうか?
- 494 名前：デフォルトの名無しさん mailto:sage [2007/12/30(日) 02:14:53 ]
- ドキュメント管理が破たんしてる業務システムの保守をやってるんだが、
・機能ごとに、仕様書があったりなかったり
・管理がずさんで、どのファイルが本物の仕様書かわからなかったり
・仕様書が現状の実装と同期がとれてなさそうだったり
てな具合。
で、どうにかせにゃアカンってことで、取り急ぎコード修正・保守作業に
最低限必要なドキュメントだけ、リバースエンジニアリングして書き起こしてる
とこなんだが、作った後の維持管理って、みんなどんな感じでやってる？
- 495 名前：デフォルトの名無しさん mailto:sage [2007/12/30(日) 11:15:07 ]
- ソースと同じくCVS管理
- 496 名前：デフォルトの名無しさん mailto:sage [2007/12/30(日) 17:27:36 ]
- 市役所の情報システム部門に勤務している人って居る？
- 497 名前：デフォルトの名無しさん mailto:sage [2008/01/02(水) 20:27:53 ]
- 市役所のシステム部門つっても、市職員がいる「○○市情報××課」みたいな
市役所ネイティブの部署と、運用を委託されてる会社の人が常駐している実務
部隊の２通り取り方があるわけだがどっち？
- 498 名前：デフォルトの名無しさん [2008/01/09(水) 12:59:45 ]
- DOXYGENだが、1.5.2以降、内部ユニコード処理になって、入力ファイルと
出力ファイルのエンコード指定ができるようになっているのはいいんだ
けど、言語とエンコードの指定に関係なく生成されたHTMLのヘッダ部分
は、「charset=UTF-8"」なんだが、ガイシュツ？
ブラウザ側のエンコード自動識別のおかげでHTMLドキュメントはうまく
表示できるが、HTML Help CompilerでHTML Helpファイルに変換すると、
インデックス部分の日本語が化ける。
- 499 名前：デフォルトの名無しさん mailto:sage [2008/01/09(水) 16:53:47 ]
- 生成されたindex.hhcのエンコーディングをUTF-8からCP932(ShiftJIS)に変換して、
hhc.exe index.hhpでおｋ
- 500 名前：498 [2008/01/09(水) 19:45:11 ]
- >>499
それじゃあ、ツールを使って自動化する意味ないじゃん。
他にも、index.hhpでのフォント指定やら変で、特に1.5.x以降を使う
メリットが見当たらないので、結局1.4.7に戻した。1.4.7は、Japanese
選択しとくと、「charset="SHIFT_JIS"」になる。
HTML Help をコンパイルする前にフォントを変更しても、Doxygenで生成
されるソースコードのページのフォントが変なんだよね。どうもアルファ
ベット部分だけ、無条件にArialになってるっぽい。
- 501 名前：499 mailto:sage [2008/01/10(木) 02:54:40 ]
- 自分はHTMLとPDFを生成できるようにnmake用のMakefile作って自動化してるんだが。
ツール側の対応に頼るのもいいけどさ。
- 502 名前：デフォルトの名無しさん [2008/01/10(木) 06:10:22 ]
- すいません、あるWindowsアプリ(制御系)のドキュメントを
作成するよう指示がありました。
ちなみに開発環境はTurboC++。
C++の知識レベルは、入門書１冊読んだ程度。（アプリ開発経験なし）
Doxygen使ってみたのですが、Doxygen対応コメントで作成されてないので
クラス階層とか関数呼出などの図ではイメージできるのですが、
コメントがないので、やってることがさっぱりわかりません。
そういう場合は、やはり、ソース解読しながら、
Doxygen対応コメントをひたすら打ち込むことから始めるべき
なのでしょうか？
- 503 名前：デフォルトの名無しさん mailto:sage [2008/01/10(木) 07:58:38 ]
- アプリのなんだからDoxygen関係ないじゃん
- 504 名前：デフォルトの名無しさん mailto:sage [2008/01/11(金) 14:48:40 ]
- Doxygen用のコメントを作るには、ある程度解析が必要だから方針としては悪くないと思うよ。
でも、そこで要求されている「アプリのドキュメント」はDoxygenの出力でいいの?
通常はその括りだと基本仕様か機能仕様に類する資料が必要になってくると思うのだけど。
- 505 名前：デフォルトの名無しさん [2008/02/10(日) 21:43:34 ]
- Doxygen 1.5.5 release age
- 506 名前：デフォルトの名無しさん [2008/02/11(月) 11:45:18 ]
- Doxygen 1.5.6 release age
- 507 名前：デフォルトの名無しさん mailto:sage [2008/02/11(月) 12:09:51 ]
- ちょっとまて
ここはDoxygenスレじゃないんだぜ
- 508 名前：デフォルトの名無しさん mailto:sage [2008/02/12(火) 14:02:50 ]
- だからといってDoxygen等の各ツール専用スレを建てると
このスレもそのスレも今まで以上に過疎るからやめてほしいぜ
- 509 名前：デフォルトの名無しさん mailto:sage [2008/02/12(火) 14:42:19 ]
- いや個々のツールの使い方はかなり無関係だろこのスレ
- 510 名前：デフォルトの名無しさん mailto:sage [2008/02/12(火) 14:47:10 ]
- 保守代わりってことでいいと思う
- 511 名前：デフォルトの名無しさん mailto:sage [2008/02/12(火) 15:06:37 ]
- 一ヶ月も放置されてたスレに、自分の意にそぐわないレスが二つ付いただけで
噛み付く奴って何なの？
- 512 名前：デフォルトの名無しさん mailto:sage [2008/02/12(火) 15:33:25 ]
- 問題は時系列ではなく内容である
「1ヶ月ぶりのレスだから何書いても許す」というほうが不条理
- 513 名前：デフォルトの名無しさん mailto:sage [2008/02/12(火) 15:35:41 ]
- 不条理もへったくれもないだろ。スレ違いと言うほど外れた内容じゃないんだから。
敢えて>509の言うように「個々のツールの使い方」は無関係だとしても、「個々のツールの情報」は無関係じゃないだろ。
- 514 名前：デフォルトの名無しさん mailto:sage [2008/02/12(火) 15:46:47 ]
- >>512
何書いても許すなんて言ってないだろ、ボケ
「お前の意に沿わないレス」で噛み付くなって言ってんだ
- 515 名前：デフォルトの名無しさん mailto:sage [2008/02/12(火) 16:05:15 ]
- お前の意に沿わない「お前の意に沿わないレス」へのレスに
噛み付くなともいへり。
- 516 名前：デフォルトの名無しさん mailto:sage [2008/02/12(火) 16:06:10 ]
- すまん、あまり面白くなかった。
- 517 名前：デフォルトの名無しさん mailto:sage [2008/02/12(火) 16:15:09 ]
- よし、いいぞもっとやれ、もっと罵りあえ！
いいですか、↑これがどうしようもないレスという物の見本です
- 518 名前：デフォルトの名無しさん mailto:sage [2008/02/12(火) 16:17:58 ]
- まあ久しぶりににぎわってよかった。
↑これはどうかな。優等生過ぎてどうしようもない？
- 519 名前：デフォルトの名無しさん mailto:sage [2008/02/12(火) 22:50:57 ]
- ﾄﾞｷｭﾒﾝﾄ書くのﾒﾝﾄﾞｸｾｪ・・・
そもそも何を書いていいのか分からんのだよ
- 520 名前：デフォルトの名無しさん mailto:sage [2008/02/12(火) 23:44:47 ]
- >>519
大丈夫だ。どうせ誰も見ない。
ぐらいの気持ちで書いてまつ。
本当に皆が必要な内容ならそんな悩まなくても書けるよ。
- 521 名前：デフォルトの名無しさん mailto:sage [2008/02/13(水) 01:27:10 ]
- 「～したら期待したとおりにうごかねーぞｺﾞﾙｧ」ときた時に
「ドキュメントは読みましたか？ﾌﾌﾝ」とするために書く。
- 522 名前：デフォルトの名無しさん mailto:sage [2008/02/13(水) 23:08:46 ]
- ソースコードにドキュメント付けするときには、
とりあえず日付を真っ先に書くようにしている。
ほかの文章は後からでも書けるけど、
こればっかりは後から思い出そうとしても思い出せない。
- 523 名前：デフォルトの名無しさん mailto:sage [2008/02/15(金) 15:13:16 ]
- 書いてすぐコミットしようよ・・・
- 524 名前：デフォルトの名無しさん mailto:sage [2008/02/16(土) 12:59:06 ]
- >>522
ついでに天気とその日の主な事件も書いとけ
- 525 名前：デフォルトの名無しさん [2008/02/26(火) 20:56:32 ]
- source code に含まれないドキュメントに数学記号使った数式を
書いたら怒られたんだが, なぜ?
- 526 名前：デフォルトの名無しさん mailto:sage [2008/02/26(火) 23:47:14 ]
- >>525
理由も聞かなかったのか？馬鹿
- 527 名前：デフォルトの名無しさん mailto:sage [2008/02/27(水) 00:17:20 ]
- >>526 意味がわからんとゆわれた
- 528 名前：デフォルトの名無しさん mailto:sage [2008/02/27(水) 00:26:10 ]
- プログラマなら常識ですと言ってやりたいなｗｗｗｗ
- 529 名前：デフォルトの名無しさん mailto:sage [2008/02/27(水) 00:26:46 ]
- >>527の意味もわからんわ馬鹿
- 530 名前：デフォルトの名無しさん [2008/02/27(水) 15:40:49 ]
- >>437
俺も重複を避ける為にそう思った。
が、この文法では、@param属性(入力,出力、入出力)が付けられない。これは痛い。
従って、@paramを使わざるをえなかった。
//445
ダメだよ、それじゃ。パッと見でもおかしいし、実際 変な表示になるよ。
- 531 名前：デフォルトの名無しさん [2008/03/05(水) 23:50:08 ]
- マニュアル・手順書を作るのに、使うのはWord？Excel？
俺はExcel派。
Word使うヤツの気が知れない。
要するに、あとで文章直すときに改行がExcelだと
大変だってだけの話でしょ？
レイアウトは断然Excel優位だよね。
- 532 名前：デフォルトの名無しさん mailto:sage [2008/03/05(水) 23:52:51 ]
- まだEXCEL使い奴いるんだな
- 533 名前：デフォルトの名無しさん mailto:sage [2008/03/06(木) 09:04:30 ]
- つられませんから。
でもスタイル指定しないWordはひょっとしたら
確かにExcelよりクソかもしれない。
- 534 名前：デフォルトの名無しさん mailto:sage [2008/03/06(木) 16:21:43 ]
- まあ、Excelの方が向いてるドキュメントはあるわな。
- 535 名前：デフォルトの名無しさん [2008/03/07(金) 01:26:50 ]
- >>531
> マニュアル・手順書
にかぎるんだったら, エディタで書いた平テキスト
エンドユーザー向けのマニュアルは別部門が作る
図面ほしいって言われたら、CAD 図面
# 新規ハード使う組み込み系の仕事がほとんどだが
- 536 名前：デフォルトの名無しさん mailto:sage [2008/03/12(水) 18:34:18 ]
- ここはdoxygenスレじゃない事は分かっているのですが・・・ちょっと質問。
関数仕様書を作るのにdoxygenを使おうとしています。 ver1.5.5を使っている
のですが、HTML出力は上手くいくものの、rtf出力になるとUTF-8でエンコード
されていて、テキストエディタでは日本語が読めるのですが、Wordやワードパッド
では文字化けして読めません。これではRTF出力する意味がありません。
DoxyWizardでは出力、入力ともShift-JISに設定しているのですが・・・(当然、
ソースのコメントはShift-JISです)
一体何がいけないのでしょうか？
- 537 名前：デフォルトの名無しさん mailto:sage [2008/03/12(水) 21:54:59 ]
- SHIFT-JIS
↓
SHIFT_JIS
- 538 名前：536 mailto:sage [2008/03/13(木) 09:27:00 ]
- SHIFT_JISにはなっていました。エンコード設定の所にカーソル合わせると
「gnuのlibiconv使ってるからそこのページ見ろや」みたいな表示が出るので
そこを見てコピペしたからだと思います。
HTMLはちゃんと表示出来るのにRTFがダメなのが良く分かりません。
- 539 名前：デフォルトの名無しさん mailto:sage [2008/03/13(木) 13:50:29 ]
- CP932は試した？
- 540 名前：536 mailto:sage [2008/03/14(金) 18:08:47 ]
- CP932でもダメのようです。
どうも、エンコード方式を指定するバージョンでは全てダメのようで。
具体的には1.5.2からはダメ。
仕方ないので1.5.1以前を使おうかと思います。ソースいじってなんとかする
スキルはないし。
あと、ついでにもう気づいた事。@paramコマンドで[in][out]表示が出来ますが、
HTMLでは問題ないものの、RTFでは何故か表示できません。
なぜRTFにこだわるかと言うと、提出物としてはHTMLよりもWord文書の方が良い
のではないかという事です。RTFならそのままwordで読めるし、DOCに直すにしても
ほとんど手直しの必要がないですからね。
まぁ、Word出力するなら商用ツール使えって事なのかなぁ・・・でも、ウチの会社
そんなに余裕ないし。
- 541 名前：デフォルトの名無しさん mailto:sage [2008/03/14(金) 20:30:26 ]
- defaultcharsetと合ってないor設定されていないんじゃないかな
- 542 名前：デフォルトの名無しさん mailto:sage [2008/03/24(月) 11:25:04 ]
- >>536
うちじゃどうしても日本語が必要なときはTeXで出して、pdfに落として提出した。
そうでないときは、全部英語にしておいた。
そうか、1.5.1ならRTFに日本語を出せたのか……
- 543 名前：デフォルトの名無しさん mailto:sage [2008/04/07(月) 23:38:23 ]
- ソースにdoxygenのコメントのテンプレートを挿入してくれるツールって無いですか？
たとえば
int f(int x)
{
…
}
というソースがあったら
/*!
*
* @param x
* @return
*/
int func(int x)
{
…
}
のような感じでコメントを挿入してくれるとありがたいです。
- 544 名前：デフォルトの名無しさん mailto:sage [2008/04/12(土) 21:56:16 ]
- >>543
よし、売ろう
- 545 名前：デフォルトの名無しさん mailto:sage [2008/04/13(日) 16:41:20 ]
- >>543
Visual Studioでの開発ならマクロ組めば出来るんじゃないかな
- 546 名前：デフォルトの名無しさん [2008/04/28(月) 19:31:50 ]
- ネットワークプロトコル説明するのに、状態遷移図書いて提出したら
「意味がわからん！！！ 書き直してこい！！！」
と言われてしまったんだが、おまえらどうやって説明してますか？
# 一応、説明文は遷移図一枚につき5ページくらいは書いたんだが…
- 547 名前：デフォルトの名無しさん mailto:sage [2008/04/28(月) 19:34:27 ]
- >>546
＞# 一応、説明文は遷移図一枚につき5ページくらいは書いたんだが…
説明文をだらだらと長く書きすぎたんじゃない？
- 548 名前：デフォルトの名無しさん mailto:sage [2008/04/28(月) 19:42:13 ]
- だったら図だけで分かってほしかったよorz
これじゃわからんって言うから、書き足していったらこうなった
どう説明すりゃいいんだ？
縦線ひいて斜め矢印か？
例外だらけになるやないか！！！
- 549 名前：デフォルトの名無しさん mailto:sage [2008/04/28(月) 19:46:17 ]
- >>548
怒られたのに何がダメだったのか聞いてはないの？
- 550 名前：デフォルトの名無しさん mailto:sage [2008/04/28(月) 19:50:19 ]
- >>548
箇条書きにした？
- 551 名前：デフォルトの名無しさん mailto:sage [2008/04/28(月) 19:51:26 ]
- >>549
もっと詳しく書けっていったから詳しく書いたんだが、ついでに数式まで交えて…
「例をだせや！！！」っても、「はじめてなんでありません」と…
- 552 名前：デフォルトの名無しさん [2008/04/28(月) 19:52:27 ]
- >>545
そういえば、VSってソース解析する上にマクロからアクセスできるんだったな。
ドキュメント自動生成マクロなんかあってもよさそうなのにな。
何とか工房がそうなのか？
- 553 名前：デフォルトの名無しさん mailto:sage [2008/04/28(月) 20:10:39 ]
- >>551
相手が理解できない点を、推測じゃなくて、ちゃんとヒアリングするのは無理なのか?
あと、説明するときは、いきなり本物じゃなくて、ミニマムセットで理解できるかどうか確認するとか。
そこらへんにギャップがあると、「それじゃわからん」vs「ではどう書けと」の対決になるような希ガス。
- 554 名前：デフォルトの名無しさん mailto:sage [2008/04/28(月) 21:32:33 ]
- プロトコルなんだから、シーケンス図？（自分対相手でメッセージを線で表現した奴）も
必要なんじゃない？
- 555 名前：デフォルトの名無しさん [2008/04/28(月) 22:06:01 ]
- 自分<-- メッセージ -->相手
こうかｗ
- 556 名前：デフォルトの名無しさん mailto:sage [2008/04/28(月) 23:24:10 ]
- 通信プロトコルならシーケンス図がいいんじゃないか？
状態遷移図と突き合わせできるように書けばOK
- 557 名前：デフォルトの名無しさん mailto:sage [2008/04/28(月) 23:33:37 ]
- >>556
しかし、シーケンス図だと条件分岐がすごく書きにくくない?
- 558 名前：デフォルトの名無しさん mailto:sage [2008/04/29(火) 01:20:36 ]
- パターン別に何種類か書いたらよかろうが
- 559 名前：デフォルトの名無しさん mailto:sage [2008/04/29(火) 01:28:42 ]
- 組み合わせ爆発しなきゃそれでいいかもしれんが……。
- 560 名前：デフォルトの名無しさん mailto:sage [2008/04/29(火) 12:28:52 ]
- プロトコルってのは「やりとりの規約」だかんな
やりとりに出てくるもの全てを図に入れて，なおかつどんなやり取りが行われるのかを書かないといけないんでないかい？
でもヒアリング一発ですみそう
- 561 名前：デフォルトの名無しさん mailto:sage [2008/04/29(火) 12:46:13 ]
- rfcでも参考にして書けばいいんでない？
- 562 名前：546 mailto:sage [2008/04/29(火) 14:38:51 ]
- >>561
RFC を参考にしてではなく RFC 提出できるくらいまじめに書いた
だけど、定義してるのはプロトコルなんで
「実装する奴が理解でない！！！」
結局, フローチャート書きまくりだとか数式無しだとかじゃないと
駄目らしい
だけどさ、状態遷移図をコーディングレベルに落すのは
「あんたらの仕事じゃねぇの？？？」 >>25才位のクライアントの担当者
# つか、ステートマシンとか習わかったのか？
- 563 名前：デフォルトの名無しさん mailto:sage [2008/04/29(火) 14:57:59 ]
- >>562
もしかして日本語がやばいんじゃないか？
- 564 名前：546 mailto:sage [2008/04/29(火) 15:12:04 ]
- >>563
おぉ、そうかもしれん ＞俺の日本語 Www
だれどさ、院出てから、10年以上この業界に巣食ってるけど、
いままでお目にかかったことがない ＞こんなクライアント
- 565 名前：デフォルトの名無しさん mailto:sage [2008/04/29(火) 15:23:28 ]
- クライアントは何屋さん？
- 566 名前：546 mailto:sage [2008/04/29(火) 15:44:01 ]
- >>565
今まで、地方自治体外郭団体向けに事務処理ソフト作って{る|た}会社
>>564 書く直前に
「理工系の知り合いに聞いたら、うちが悪かった」
って，電話入ってきた。
まぁ、>>564 ただの愚痴だし、確に、俺も悪かった思うが………
こんなに、言語の差があるもんなのか？
- 567 名前：デフォルトの名無しさん mailto:sage [2008/04/29(火) 16:41:31 ]
- とりあえず日本語でおｋ
- 568 名前：デフォルトの名無しさん mailto:sage [2008/04/29(火) 16:46:09 ]
- まぁ、独自プロトコルを定義した仕様書を今まで見たことないんだろうね。
いつまでも自分流儀でやって、愚痴たれながしとけばいいよ。
- 569 名前：デフォルトの名無しさん mailto:sage [2008/04/30(水) 00:07:17 ]
- 事務処理オンリーだった会社じゃ通じなくても不思議はない。
不思議はないが不甲斐ないな、そこ。
- 570 名前：デフォルトの名無しさん mailto:sage [2008/04/30(水) 02:15:31 ]
- >>543
VS2005ならDoxyCommentがいいんじゃね
書式もカスタマイズできるし
- 571 名前：デフォルトの名無しさん mailto:sage [2008/04/30(水) 02:52:52 ]
- 正直、ドキュメントが読めない
ＤＢの構成とか設計書とか。
「読んだら分かる」っていつも言われるんだけど、
どうしたらいいかな。
- 572 名前：デフォルトの名無しさん mailto:sage [2008/04/30(水) 03:18:04 ]
- >>571
落ち着いてジックリ読んでみな。
- 573 名前：デフォルトの名無しさん mailto:sage [2008/04/30(水) 10:43:42 ]
- >>566
そう言う所は、得てして「うちはどこそこの仕事をしているんだ」って妙な自負があるから
こっちが何を書いてもクレームつけるよ。謝罪の電話があっただけでもましな方かも。
# うっかりしていると、同じドキュメントを「概要」と「詳細」と「解説」の3バージョン作る羽目になったり。
- 574 名前：デフォルトの名無しさん mailto:sage [2008/04/30(水) 13:11:38 ]
- これはいい勉強になるスレ
- 575 名前：デフォルトの名無しさん mailto:sage [2008/05/01(木) 21:02:41 ]
- >>571
ドキュメントは読めるようになったほうがいいよ。人に
頼ることなく進む力がぐんと増える。(ドキュメントに
頼る時点で、というのは無しで)
どうしたらいいかと言われると解答に困るんだけど、
日頃から疑問に思ったことがあれば、まずドキュメントに
目を通すという習慣をつけてみたらどうだろう。
java でプログラミングしてて分からないことがあったら
まず javadoc を当たってみて、それでも分からなければ
ぐぐってみたりとか。
ツールのインストールの時も、まずは付属ドキュメント
(README, INSTALL みたいなやつ) に目を通すとか。
- 576 名前：デフォルトの名無しさん mailto:sage [2008/05/02(金) 10:31:47 ]
- それ、「～ほうがいいよ」ってレベルじゃなくて、「～できなきゃダメ」のレベルだと思う。
- 577 名前：デフォルトの名無しさん mailto:sage [2008/05/03(土) 13:36:57 ]
- >>546
遷移図は全体を出さずに、
ほげをするとBになります
A→B
ここでげほをするとCになります
A→B→C
ここでほれをするとAになり、やりなおしできます
A→B→C┐
←──┘
まあなんだ、たぶん図は崩れたと思うけど、インクリメンタルに
説明と共に図を成長させると理解してもらいやすい。
パワポのアニメで説明するとわかったきになるのに、
紙に出した同じ資料がわかりにくいのも同じ理由だと思う。
- 578 名前：デフォルトの名無しさん mailto:sage [2008/05/06(火) 04:58:29 ]
- >>572
>>575
遅くなったけど、ありがとう。
疑問を持ったら人に聞くクセをなくすように
がんばります。
- 579 名前：デフォルトの名無しさん [2008/05/08(木) 17:47:02 ]
- 今度開発の仕事やらせてもらう事になりました。
その前に勉強として、仕様書作ってプログラム作れって上司から
言われました。
プログラムは作ったことあるんですが、仕様書なんて作ったことありません。
常識的に考えたら、基本設計書、概要設計書、コード設計書とか全部作るべきでしょうか？
- 580 名前：デフォルトの名無しさん mailto:sage [2008/05/08(木) 20:27:21 ]
- 上 司 に 聞 け
- 581 名前：579 [2008/05/08(木) 23:52:12 ]
- >>580
言葉足らずですみません。
仕様書って何の事か聞いたんですが、自由に作っていいって言われたんです。
自由に作れと言われたら基本的な概要、機能とか画面構成など書けば仕様書としては
成り立つんだと思うんですが、いかんせん初めての経験なのでどのように書いたらいいか
わからないんですよね。
社会人の常識として設計書の本読んで基本設計書、概要設計書
など全ての設計書を作るのが妥当なのかという質問です。
- 582 名前：デフォルトの名無しさん mailto:sage [2008/05/09(金) 00:08:07 ]
- 単なる練習プログラムなんだから概要からでいいんじゃね
- 583 名前：デフォルトの名無しさん mailto:sage [2008/05/09(金) 03:44:01 ]
- 上司乙ｗ
- 584 名前：デフォルトの名無しさん mailto:sage [2008/05/09(金) 08:08:02 ]
- >>581
疲れたので途中で止めとくけど、こんな感じで読める読み物を作ればおけ。
ゴールの定義
・どういう背景があり（どういう歴史があり何で困っていたのか）
・何を実現したいと考えています（作ったものを使うことで得られると期待される効果のこと）
・このために何々をするものを作ることにしました
全体構造
・大きな制約条件として～がある中で（納期、コスト、現状からくる技術�%A
- 585 名前：デフォルトの名無しさん mailto:sage [2008/05/09(金) 08:09:41 ]
- あれ？途中で切れてしまった・・・
書き直すもの疲れたので諦めるすまん>>581
- 586 名前：デフォルトの名無しさん mailto:sage [2008/05/09(金) 09:40:43 ]
- 骨組みでこの程度がわかれば良い。
・なんで作ったのか
・それを使ってどういう効果が期待できるか
・必要とする環境
・入力は何か
・出力は何か
競合するプログラムが既にある場合を除いて、
最初はどういう機能がとか、画面が云々とかは不要。
必要だといわれたら付け足していけば良いはず。
読む側にとってどうでもよさそうな事は極力避ける事。
つーか多分作ったのを後で添削するのが
意図なわけだから、あまり時間掛けると嫌われるぞ。
- 587 名前：581 [2008/05/09(金) 16:21:25 ]
- >>586
入力、出力ってどういう意味ですか？
A4用紙一枚にまとめるのは変でしょうか？
|
 |
