2ちゃんねる ★スマホ版★ ■掲示板に戻る■ 全部 1- 最新50  

■ このスレッドは過去ログ倉庫に格納されています

ドキュメント・資料に関するスレ

1 :仕様書無しさん:03/11/17 00:02
ソフトを作成する前に、設計書や仕様書を書いたり
ソフト作成した後にも 、
そのソフトのドキュメントを書いていると思うけど 、
そういった、ドキュメントに関するスレです。

・こんなドキュメント作成ツールがあるよ
・こんなドキュメント必死こいて書いている奴いるけどムダムダ
・こういうドキュメントはぜひ残しておいてくれ
・こんなドキュメントは書いておくと重宝がられるよ
などなど、ドキュメントに関することを
なんでもカキコしてください。

どんなソフトを作成しているかも、書いてくれるとより分かりやすいです


2 :仕様書無しさん:03/11/17 00:06
ドキュメント書くのって面倒くさいよな。
SEじゃないから、それでも少ない方だけど、
俺は、一太郎でシコタマかいているんだけど、
もう、ウザくて発狂したくなる時があるよ。
なにか、ドキュメントを書く便利なツールやソフトって無い。
特に、作り終わった後の完成図書を書くのが面倒くさい



3 :(^ー')b ◆EoOYgmEaZE :03/11/17 00:14
分かりやすいドキュメント書くのは一種の才能です

4 :仕様書無しさん:03/11/17 00:16
漏れはドキュメント修正とか言って、設計書のフォントとサイズを直したことある。 はっきり言って気が狂いそうになる。 こんなことしても意味ないと思わないか?

5 :仕様書無しさん:03/11/17 00:20
うちには設計書作成に使うマクロがいっぱいあるよ。
DB定義なんかは、設計書からCreate文を作るしね。
ページ降りとかフォントあわせとかを手作業でやるのはつらいよね。

6 :仕様書無しさん:03/11/17 00:20
>2
>特に、作り終わった後の完成図書を書くのが面倒くさい

Visio とかでもリエンジニアリング機能とか使えば、JavaからUML図とか
おこせるだろう。

少なくとも一太郎よりかはいいツールはあると思いますよ。


7 :外注業者 ◆PVCAbsPHPE :03/11/17 00:22
面倒くさいなんて言っていたら、仕事にならないよ。
ツールに頼っても、わかりやすい資料になる保証はないし。
結局は自分で考えて書くべき。
ていうか、このスレッドにいる連中の言う設計書って、詳細設計書だろ?

8 :仕様書無しさん:03/11/17 00:26
面倒くさいけど仕事だからやるんでしょ??

9 :仕様書無しさん:03/11/17 00:36
面倒だから仕事になるという考え方も良いが、その仕事をいかに楽にこなすか考えることも重要

10 :仕様書無しさん:03/11/17 00:38
>>7 私の場合は、機能仕様書ですが。なにか。

11 :仕様書無しさん:03/11/17 00:48
>>7 設計書は工程ごとにつくるだろう。
UI工程ならUI設計書ってな具合にな。
詳細設計書しか作ってないってことはお前は下っ端だな。

12 :仕様書無しさん:03/11/17 00:56
>>11
そんな君ローカルな定義を持ち出されても困ってしまうわけですが。

13 :仕様書無しさん:03/11/17 01:19
>>5

マクロってことは、Excelですか?
例えば、どんなマクロを作ってあります?

14 :仕様書無しさん:03/11/17 01:21
>>9

例えば、どんな

15 :仕様書無しさん:03/11/17 01:24
5じゃないけど5と同じく
・定義書からDBのCreate文を作るマクロ
・ページ振り、フォントあわせ
のマクロはほぼ標準でどのPJでも使えるようにしてある。
それから設計書ってファイルを分けなきゃ行けない場合があるので
まとめて印刷するマクロとかね。


16 :仕様書無しさん:03/11/17 01:27
>>15
気の利いたDB設計ツールを使うか、気の利いたフロントエンドでDB作ってリバースエンジニアリング
したほうがいいかと思うがどうだろう。

17 :仕様書無しさん:03/11/17 01:39
ソースコードからクラス図を自動生成すれば
ドキュメントの大半が出来上がる。


18 :仕様書無しさん:03/11/17 01:41
UMLまんせー

19 :仕様書無しさん:03/11/17 01:48
>>15

こんな感じ・・
ってのが、どっかのHPからダウンロードできると
分かりやすいな。

そんな、サイトないかな?

20 :仕様書無しさん:03/11/17 02:01
>>19
>>16

21 :仕様書無しさん:03/11/18 09:08
ソフトを作成した後の、完成ドキュメントって、どんなの書かれています?
ウチの会社は、みんなロクなドキュメントを書かないので、
本人が休んだりした時に、トラブルがあったらもう大変、
休んだならまだいいけど、辞めちゃったら、
白旗モードです。
制御系のソフトを作っているんですが、
どんな、ドキュメントを残すようにすれば、
こういった事態を免れますか?

22 :仕様書無しさん:03/11/18 09:21
>>21
ソフトウェアのソースコードに、詳細な仕様を書かせましょう。
何を考えて書いたか全て理解できるように書かせましょう。
もしコメントが無いソースがあったら、蹴りましょう。
コメントだらけで、関数名や変数名が糞だったら、やはり蹴りましょう。
これで大部分の問題が解決します。

23 :仕様書無しさん:03/11/18 12:18
>>21
ソースファイルからドキュメントを生成するツールを調査すべし。
JavaDoc(java用)とかDoxygen(c++用)とか。
生成されるドキュメントに記述されるべき情報は自分で判断汁。
以上が嘘の回答。

本当の回答は、「読んで理解出来るソースを書くこと」

24 :仕様書無しさん:03/11/18 15:10
どんなクソソースでも読めるように鍛える

25 :仕様書無しさん:03/11/18 16:45
PのMさん。
あなたのカラフルなフロー図、見づらいです。
あなたは塗り絵ができて楽しいのかもしれませんが、それを検討させられるこちらの身にもなって下さい。

ってかおまえ、内容ちゃんと検討してんのか?単に塗り絵したいだけじゃないかと小一時間(ry


26 :仕様書無しさん:03/11/19 00:24
>>22
コメントに嘘を書いてる奴が居ます。
こいつも蹴っていいですか?
っていうか、コピペしてコメントは変えてないだけだと思うけど。


27 :仕様書無しさん:03/11/19 00:27
ぷるぐらまなら、ワードや一太郎じゃなくて、LaTeX かせいぜい HTML だよね。

28 :なぎさっち ◆Nagi/FmYMM :03/11/19 00:29
コメント書けってのは、大いに分かるし賛成なんだが、契約書に納品物件としてドキュメントって明記されてないのか?

29 :仕様書無しさん:03/11/19 00:30
>>26
嘘でも何でも騙されるおまえの力量不足。
ソースが全てを語る。

30 :仕様書無しさん:03/11/19 01:08
えっとVB全く知らないんで、どうなのかわかりませんが
この前拝見したソースに

If FlagCheck(blnFlag) And blnFlag = 0 Then
blnFlag = 0
End If

こんなのあったんですが、すんっごい考えさせられました
とってもエレガントだなーと、Ifってif文?

31 :仕様書無しさん:03/11/19 01:39
>>30
何コレ?
VBって気持ち悪い。

32 :外注業者 ◆PVCAbsPHPE :03/11/19 07:49
>>30

フラグを多用するのは、スキルが低い証拠。
フラグを利用せずに、条件分岐に応じた関数を作成するべき。

33 :仕様書無しさん:03/11/19 17:07
>>29
ソースはやってることしか語ってくれないぞ。
そのデータはどんな意味なのか とか、(実装上のマージンを除く)値の範囲とかまでは書いてないこと
多いぞ。
んでもって、ソースのみから全体像やそのシステムの目的をイメージするのも大変だ。

ソースより後でいいからドキュメントはちゃんと用意しといた方がいい。


34 :仕様書無しさん:03/11/19 17:59
>33
こいつって。。。

35 :仕様書無しさん:03/11/19 18:02
>>33
そだね。ソースしかないと「プログラムの仕様」までたどり着くのは大変な作業だ。
たどり着いた「プログラムの仕様」の正しさを検証する方法もないしね。
指摘している「全体像」に相当する部分かな。これがちゃんとドキュメントになっていないと保守担当が泣く。

36 :仕様書無しさん:03/11/19 18:47
プログラムから読みとれるのは、
「この条件の時は、こう処理する」ということだけ。
「なぜそうするのか」はわからない。
まあ仕様書に書かれているとも限らないがな。

37 :仕様書無しさん:03/11/19 22:59
おまいらの会社ってレベル低いんだな。
上流、下流ともにカスが集まってるとこはそうないぞ。

38 :仕様書無しさん:03/11/20 01:44
>>37
レベル低いっていうか、末端なんだろうね。


39 :仕様書無しさん:03/11/20 02:52
ま、言葉のあやだと思うが…
使っているデータや値の範囲の意味や意図がわからないコードを書いて、
ドキュメントで補完しようとしてはならない。それはマジックナンバーだ。
システムの全体像や目的がわからないというのはドキュメント以前の問題だ。

40 :外注業者 ◆PVCAbsPHPE :03/11/20 07:52
>>33-39

ひどいソースなんて、どこにもあるだろ?
経験の少ない人が書いたソースとか、年寄りが書いたソース。
きちんとレビューしていないと、そういう状態で残ってしまう。
ソースのひどさを補うために、ドキュメントが必要だ。

41 :仕様書無しさん:03/11/20 11:07
ソースのひどさを補うために、ドキュメントが必要だ。
ソースのひどさを補うために、ドキュメントが必要だ。
ソースのひどさを補うために、ドキュメントが必要だ。
ソースのひどさを補うために、ドキュメントが必要だ。
ソースのひどさを補うために、ドキュメントが必要だ。
ソースのひどさを補うために、ドキュメントが必要だ。

あんたすごいね

42 :仕様書無しさん:03/11/20 11:20
いかにもコーダってかんじだな。
こいつとは仕事したくねー。

43 :仕様書無しさん:03/11/20 13:58
>>38
だね。
だからドキュメントはソースですなんてほざくんだろうなぁ。

クライアント側の上の人や自社役員なんかに、ちょっとデモやプレゼンする時に
いちいちソース読まされてたらたまったもんじゃないよ。


44 :仕様書無しさん:03/11/21 22:09
世の中には金出してでも読みたい文章ってのもあるのに、
技術者の書く文章ってのはなんでこーゴミ以下のものが多いんだろうね。

45 :仕様書無しさん:03/11/21 23:43
W3Cの糞文書だけはもう読みたくねー
毎回、糞文書の暗号解読するだけで頭パンクでJM状態
仕様考えてる人が頭がいいのは十分わかったから
もっと表現技法とか学んで、誤解生まないような説明してくれ
図とか解説とかバンバン入れてくれ

46 :仕様書無しさん:03/11/22 00:24
>>1
バイブルだ。嫁。

理科系の作文技術
http://www.amazon.co.jp/exec/obidos/ASIN/4121006240/249-5535646-6125937


47 :仕様書無しさん:03/11/22 11:27
バイブだ。嫁
いやん、あなたぁ〜

11 KB
■ このスレッドは過去ログ倉庫に格納されています

★スマホ版★ 掲示板に戻る 全部 前100 次100 最新50

read.cgi ver 05.02.02 2014/06/23 Mango Mangüé ★
FOX ★ DSO(Dynamic Shared Object)