良いドキュメント・マニュアル・仕様書を書くスレ
■ このスレッドは過去ログ倉庫に格納されています
0001デフォルトの名無しさん
NGNGドキュメントを書ける自信はあるか？
仕事で納品したり、他人に見せるプログラムとして公開するつもりなら、
マニュアルや、仕様書などのドキュメントを書く機会は必ずある。
プログラムとドキュメントはとても関係が深い。ドキュメントが整っていない
プログラムなど、ゴミと同じ。それに、ただ書けばいいって物でもない。
ドキュメントがゴミ程の役にも立たなければ、結局それはゴミなのだ。
だらだらと書いた意味不明な文章を他人に見られるのも恥ずかしいよな？
いわばドキュメントを書く技術はプログラマの必須スキルの１つなのだが、
実際は、下手糞なドキュメントが蔓延っている。(これはGNU製に多い)
読んでも無駄とか、書いても無駄とか思ってる奴、その考えを改めろ。
プログラムに対するドキュメントを、ちゃんとした１作品として、
後世に残せるよう努力すべきだろう。
今一度問う。
おまえら、わかりやすく的確なドキュメントを書ける自信はあるか？
0002デフォルトの名無しさん
NGNG■■■■■■■■■■■■■■■■■■■終了■■■■■■■■■■■■■■■■■■■■■
0003デフォルトの名無しさん
NGNGこれは偏見じゃねーか？（ｗ
まあ否定する要素もないけど。
0004デフォルトの名無しさん
NGNGプロジェクトの存続にも関わる。
0005デフォルトの名無しさん
NGNGとか言うやつはアホだな。
0006デフォルトの名無しさん
NGNG0007デフォルトの名無しさん
NGNG0008デフォルトの名無しさん
NGNGそもそも今までム板にドキュメントの書き方系のスレが無いってのがちょっと気になった。
みんな関心が無いのか、それともＤＱＮなドキュメント書いてる奴は自覚が無いのか。
0009デフォルトの名無しさん
NGNGそれ以外は最終的にはソース見ろになるから、詳細レベルは不要。
設計時は通じるレベルで記述して、後は仕様書作成ツール様に任せる。
0010デフォルトの名無しさん
NGNGこういう話題もマ板なの？
ドキュメントを記述する上での技術的な話題とすれば、
ム板でもいい気がするけど。
0011デフォルトの名無しさん
NGNG会社によってフォーマットがあまりにも違うので語りようがなかったりして。
ちなみにうちは検査に出すドキュメントに決められたフォーマットはなし（笑
0012デフォルトの名無しさん
NGNG取り辛くなっちゃうから意図的に残さないｗ
0013デフォルトの名無しさん
NGNGこれはソースとドキュメントが別ファイルなのが問題ではないか？
ということで、doxygenみたいなツールを使うことである程度緩和される。
ただしdoxygenはC++専用。
各言語毎にこういうツールを用意する必要がある。
0014デフォルトの名無しさん
NGNG自信ないよ。
四苦八苦しながら書いてる。
それで、教えてくれるの？
0015デフォルトの名無しさん
NGNGマニュアルの「わかりやすさ」とは，①書いてあることの意味がわかる，②どこに書いてあるかわかる，③知りたいことが書いてあるの３点です。
0016デフォルトの名無しさん
NGNGgraphvizのフォーマットで書き出してくれるだけでもいいんですが。
0017デフォルトの名無しさん
NGNG言語・環境を書けよ。
0018デフォルトの名無しさん
NGNGC++でお願いします。
0019デフォルトの名無しさん
NGNG企画段階で想定したマニュアルの利用者（読み手）の知識・技術・能力
のレベルに合わせて，理解しやすく，読みやすい文章を書くようにします。
短い文を心掛ける－－１センテンスは３５～５０文字位が適当
１センテンスが長文だと，意味を読みとり難くなります。１センテンス
３５～５０文字を目安として，１つの文脈を表すようにします。
接続詞の使い方に注意を
「そのうえ」，「さらに」，「しかし」など，接続詞で文章をつなぐと，
めりはりのない文章になりがちです。
読点の使い方
また，主語には原則として読点（，，）をうちます。こうすることに
よって主語と述語の関係が明確となります。これにより読み手の
意味の取り違えや，読み誤りを防ぎます。
「です。ます調」で，使用者（読み手）の共感を得る
「です，ます調」は，読み手が親近感を持つ表現であるところから，
読む気を引き出す，あるいは，“利用者の共感を得る”といった観点
から，マニュアルに適した文体です。
なお，「である調」は，事実を正確，簡潔に表現するのに適した文体
です。
0020デフォルトの名無しさん
NGNGttp://www2s.biglobe.ne.jp/~kobayasi/manual/manual06.htm
よくまとまってるので、指標にはなるんじゃないかな
0021デフォルトの名無しさん
NGNGそういうのDOS時代にはあったな。
関数の呼び出し関係を木構造で出力するやつ。
graphvizみたいなグラフじゃないけど。
doxygenじゃ手動でも書けないんだっけ？
0023デフォルトの名無しさん
NGNG0024デフォルトの名無しさん
NGNG0025デフォルトの名無しさん
NGNGＪａｖａ等のＳｔｒｉｃｔな言語でほぼ実際の動きをエミュ
レートするソースがあれば、当面はそれ
に勝るマニュアルや仕様書はないんじゃないのか？
１０年位して、バージョンアップが殆ど無くなった段階で
初めて詳細な仕様書やマニュアルを日常語に近い言葉で
書けばＯＫじゃないの？
0026デフォルトの名無しさん
NGNG0027デフォルトの名無しさん
NGNGされたコードは売り物にならないと思うべきだが）
というか、大抵の場合、日常語で書かれた仕様書というのは、多かれ少なかれ
顧客の業務の重要な情報を含むことが多いわけで、書かれたものは基本的に
顧客に返却して管理させるべきもので、それをどこの馬の骨ともわからない
人間に見せてダイレクトにコード化させることが犯罪的なんだよ。
まだ良心的な会社は、それじゃまずいから、意図的にコーディング上重要な
情報を小出しにし過ぎる。実装不能な仕様を渡されてそれをコード屋のせいに
する。丁度中間のバッファが必要なわけだ。少なくとも実動作する程度のもの
を作って、その中で守秘義務上、伏せておきたい情報を隠蔽すればいいわけだ。
論理的に数分割して時間差をつけて別会社に発注するだけで情報漏洩はかなり
防げる。
0028デフォルトの名無しさん
NGNG論理設計書、物理設計書
外部設計書、内部設計書
基本設計書、詳細設計書
システム設計書、プログラム設計書
呼び方はいろいろだが、いったいどのレベルの設計書の話をしてるんだ？
0029デフォルトの名無しさん
NGNGとかを使ってイメージを表現すればよい。
計画書：アイデアを前向きに検討する時に作成される。論理的に矛盾が無いか
算術的に不可能ではないか、統計的パラメータの準備は十分か、検証される。
体系的でなく、断片的なものの集積。
Word（論理的妥当性）/Excel（算術的妥当性）/Access（統計的妥当性を使
って書かれる。決してこの段階では仕様書とは呼ばない筈であるが、何故か
この国では仕様書と呼ばれる。
設計書：基本計画がまとまった後、上記計画書群をもとにそれらをつなぎあわせて
一枚の設計書にする。この際に厳格なライブラリを持った言語が好ましいことは
言うまでも無い。.NETやJava等が適している。仮想マシン上で正常動作すること
が大前提。しかし、設計書が完成してもまだ実装段階ではない。
＋αが重要。
＋αとは、プログラムに含まれているパラメータに調整要素をつけること。その
調整要素に優先順位を指定すること。これを行う為には熟練が必要。
この調整パラメータを含んだ設計書が規格書。
実際のコーディングは規格書に基づいて行われるべきである。しかし実装段階
では、調整パラメータを利用した修正が不可避的に必要。（ロジックやアルゴリ
ズムの修正は余りない。環境固有の要素やハードウェアの物理的側面から多少の
変更はあるが、パラメータ修正に較べれば小さい）パラメータ変更は上流に
フィードバックされ、規格書の変更を余儀なくさせる。
これを繰り返して、規格書が仕様書に近付いていく。
結論：
仕様書が出来る前に必ずブツが出来る。
いきなり仕様書を書ける奴は神。
0030デフォルトの名無しさん
NGNG「規格書」とはなんしょうか？その説明が無いので、あなたのいう「仕様書」がなんなのか
よくわかりません。
それから普通は「構想書・提案書・稟議書」と「計画書」の間になにかあると思います。
日本語では『要求仕様書』、アメリカでもrequirement specificationと言うと思います。
0031デフォルトの名無しさん
NGNGあ、すみません。規格書の説明はありましたね。第一パラグラフは取り消します。
0032デフォルトの名無しさん
NGNGわかるとおもいますが、システムを作る入り口となるものは「要求仕様」であり、
それを書類にしたものが要求仕様書で、この位置づけの仕様書が無いとシステムが
作れないと思います。
0033デフォルトの名無しさん
NGNGどの分野の人？
パッケージ？ゲーム？情シスの人？
0034デフォルトの名無しさん
NGNGとは言わず、計画書群の一部だろな。
ただ総合計画書を作る段階でどんどん要求が絞り込まれていく。
これは予算とか工期などの生臭い要求も関係してくるというか、殆どの場合
がそれ。この過程でそれまでの前向きな基調だった計画書群とは異なって
やや後ろ向きな要求定義書と呼ばれるバージョンが出てくる。総合計画書
を作る段階では意外に高い影響力を持つ。だから計画書を書かされた人間は
要求定義書を書いた奴を内心憎んだりする。
なお、総合計画書を書く段階で、実装には無関係という前提のもとで、
一応完結的なアプリケーションの形にしても良い。（勿論ソースも残す）
かなり細かい部分まで記述可能な例えばDelphi等を使うと良い。Delphiは
総合計画書を書く段階で最も活躍する言語かも知れない。（但し長期的に
使うのには色々と問題があるので、継続的に使用してはならないと思うべ
きだが）これは企画書を書く段階の助けになるからである。
0035デフォルトの名無しさん
NGNG0036デフォルトの名無しさん
NGNG0037デフォルトの名無しさん
NGNG0038デフォルトの名無しさん
NGNGD'ont think feel!
0039デフォルトの名無しさん
NGNG0040デフォルトの名無しさん
NGNG何語ですか？
0041デフォルトの名無しさん
NGNG総合計画書を作るまでは夢。要求定義書はなんつうかもう空絵事。
総合計画書を作る段階でどんどん退化。
生臭い要求も関係してくる。この過程で夢は消える。
要求定義書は、総合計画書を作るときやけに高い影響力を持つ。
だから計画書を書かされた人間は
要求定義書を書いた奴を脳内でぶちのめす。(-_-#)< FackYou!
総合計画書を書くときDelphiでプロトタイプ作っても良さげ。
(ただしそのまま開発にDelphi使うと問題が多発するという諸刃の剣)
まあ、企画書を書く段階の助けにはなるだろうってこった。
0042デフォルトの名無しさん
NGNG瞬間的に巨大なものを作るのは得意かも知れないが。
0043デフォルトの名無しさん
NGNG0044デフォルトの名無しさん
NGNGスクリプトを導入すればいいのに。
ちょっと直す都度コンパイラのコードに手を入れるなんて・・・まるでCOBOLだ。
0045デフォルトの名無しさん
NGNGWeb-browserだとか非常に永続性の高い重く巨大で安定した土台がある
からこそ動くわけ。
この土台を構築するのには膨大な金がかかっている。（見た目そっくりなものは
簡単に作れるが）
Script言語を動かしても壊れない土台は実はそう短い時間じゃ作れない。
あと、こういった安定土台＋Script＝理想と考えるのは間違い。
重く巨大な土台が影響して、実は本当に大きな環境激変に耐えられなかったり
する。（ちょっとした変化なら、他よりも非常に巧く対応するが）
0046デフォルトの名無しさん
NGNGいやスクリプトといっても有名所の肥大化したものじゃなくて
せいぜい5千行くらいで書けるような小さなものでも結構役立つよ。
自分は色々作ってやってる。テキストをそのまま実行するものと
もう少し速度が必要な用に中間言語型の２つね。
さっきも仕様変更のメール来たけど、スクリプトの部分だけ変更してメールで送った所だ。
Delphiはバリアント型があるのと、実行時型情報のおかげでスクリプトが簡単に作れて組み込めるのがありがたい。
0047デフォルトの名無しさん
NGNG0048デフォルトの名無しさん
NGNGＯＳが必要になり、ＯＳ固有のライブラリでアプリを作る。
優秀なアプリの上にスクリプト言語やマクロ言語が発生し
やがてそのアプリはＯＳのサブ環境に近づいていく。
スクリプト言語もやがてライブラリが整理され、文法も
補われて単なる言語になる。その言語で書かれたアプリが
再び環境となって....
こうして、ＯＳの上にＯＳが出来てさらにその上にＯＳが
出来るという無限連鎖が発生するように見える。ＣＰＵの
スピードアップはそれを普通に可能にする。
ただこういうのを砂上の楼閣というんだろうね。最終的に
使うのは人だから、上が崩れると下まで巻き込んで、すべて
崩れてしまう。その危険性を日頃から意識しているかいないかで
長期的にみてぜんぜん違ってくる。
0049デフォルトの名無しさん
NGNG0050デフォルトの名無しさん
NGNG0051デフォルトの名無しさん
NGNG0052デフォルトの名無しさん
NGNG0053デフォルトの名無しさん
NGNGライブラリが違いすぎ。
言語仕様なんてライブラリに比べたら問題にならないでしょ。
0054デフォルトの名無しさん
NGNG適当でいいんだよ。
0055デフォルトの名無しさん
NGNGない。「ダイアモンドウェア」であってハードウェアよりもず～っと硬い。
これを現実のハードに適用するとどういう結果を招くか。つまりJavaで
書かれたソースはあくまでも実装準備段階で、別にもう一度ソース最初から
書き直さなければならないってことね。真に良いソフトウェアを書く為には
ダイアモンドのように硬いソースが必要だったりすることもあるから
Javaの存在価値はMSが言うほど小さいものではなかったりする。
ただしそれは十分に柔らく書き直してから使うべきだろうけどね。
0056デフォルトの名無しさん
NGNG0057デフォルトの名無しさん
NGNG>>55をexcite翻訳を使って英訳、
できなかった部分は原文を意味が変わらない程度にいじって再び英訳、
そしてそれを邦訳。結果はこれ。
Javaによって少なくとも書かれたソース・コードについては、
これが「ソフトウェア」にあります。何もありません。
それは「ダイヤモンドの着用」で、ハードウェアよりはるかに困難です。
これが応用の困難な[現実]である場合、
どんな結果が引き起こされるでしょうか。
で、すなわち、書かれたソースがそうであるJava、
最後への増大する準備段階でもう一度独立して始まるソースから。
書き直しに対して持っています。
ハードソースがダイヤモンドのように時々要求されるので、
非常によいソフトウェアを書くために、
Javaの存在価値はMSが言うほど小さくありません。
しかしながら、それは十分に柔らかに書き直した後に使用されるべきですか。
0058デフォルトの名無しさん
NGNGあとはスクリプトが仕様書って事かい？
0059デフォルトの名無しさん
NGNG保守するときだって仕様書なんか信用しない。
「地図と土地が一致していなければ必ず土地の方を信用しろ」の格言のとおり、
「ソースと仕様書一致していなければ必ずソースの方を信用しろ」なんだ。
仕様書がいくら立派でも、保守不能な（保守が現実的でない）ソースは
保守不能なんだ。
0060デフォルトの名無しさん
NGNG相容れない？
集団主義社会＝北朝鮮、戦前の日本。
http://www.pref.aichi.jp/jinken/century01.html
「人権の世紀」という言葉を聞いたことがありますか？
労働相談・ご意見
http://www.jtuc-rengo.or.jp/new/sodan/mail/rodo_sodan.html
0061デフォルトの名無しさん
NGNG●とにかく臆病・神経質で気が小さいだけ（真に他人を思いやる気持ちには欠けている、二言目には「世間」(「世間」と言っても、一部のＡ型を中心とした一部の人間の動向に過ぎない））。
●異常に他人に干渉して自分たちの古いシキタリを押し付け、そこから少しでも外れる奴に対しては好戦的でファイト満々な態度をとり、かなりキモイ（偏狭、自己中心、硬直的でデリカシーがない）。
●妙に気位が高く、自分が馬鹿にされるとカッと怒るくせに平気で他人を馬鹿にしようとする（ただし、相手を表面的・形式的にしか判断できず(早合点・誤解の名人)、内面的・実質的には負けていることが多い）。
●基本的に悲観主義でマイナス思考なため性格が鬱陶しい（根暗・陰気)。
●とにかく否定的でうざく、粗探しだけは名人級（例え10の長所があっても褒めることをせず、たった１つの欠点を見つけては貶す）。
●社会的強者には平身低頭だが、社会的弱者に対しては八つ当たり等していじめる（強い者にはへつらい、弱い者に対してはいじめる(人が見ていないときは、より一層））。
●少数派の異質・異文化を理解しようとせず、あるいは理解を示さず、排斥する(多数派＝正しい と信じて疑わない、了見が狭い差別主義者）。
●何でも「右へ習え」で、単独では何もできない（群れでしか行動できないヘタレ）。そのくせ、集団によるいじめのリーダーとなり皆を先導する（陰湿かつ陰険で狡猾）。
●他人の悪口・陰口を非常に好むと同時に、自分は他人からどう見られているか、人の目を異常に気にする（自分がウソツキだから他人のことも容易に信用できない、ポーズだけで中身を伴っていない）。
●友人関係は、表面的な浅い付き合いでしかなく、心の友はおらず孤独（他人の痛みがわからず、包容力がなく、冷酷だから）。
●頭が硬く融通が利かないため、すぐにストレスを溜め、また短気で、すぐに爆発させる（不合理な馬鹿）。
●後で自分の誤りに気づいた場合でも、素直に謝れず強引に筋を通そうとし、こじつけの言い訳ばかりする（社会悪の根源、もう腹を切るしかないだろう！)。
●男は、女々しいあるいは女の腐ったみたいな考え(例：「あいつより俺のほうが男前やのに、なんでやねん！（あいつの足を引っ張ってやる！！）」）。
0062デフォルトの名無しさん
NGNGていって成長するもの。仕様書候補を書こうというものは実装ソース
を書く人のニーズを真に理解していなければならないし、実装者も
仕様書候補の行間を読んで真に必要とされているものを生かしていか
なければならない。
最初に完成された仕様書があって環境毎に異なるバリエーションを持
ちえるプログラムコードはそれに従属し翻訳されたものであるという
考え方は最終的な結果論であり理想論。
というか、その状態になって初めて「仮想原本」たる仕様書と呼べる
水準のものになる。この仕様書の価値こそが極めて高いわけで、これ
が生まれることをほのかに期待するからこそ人はプログラムという邪
道に敢えて入り込むわけ。
ダイヤモンドを散りばめた服が、決して服の究極の代表的な姿にはな
りえないのと同じように、ソフトウェアも硬く鋭く光る部品で構成
されているものが終局的な姿だというわけでもないだろうね。
ま、一度その方向に極端化してみる（洗練と人は言う）というのはそ
れはそれでいて得られるものは大きく貴重なものも多いのだろうが。
0063デフォルトの名無しさん
NGNG0064デフォルトの名無しさん
NGNGちゅーか、ながい。
沢村の友達なんだ炉。
0066デフォルトの名無しさん
NGNG0067(゜Jし゜）
NGNGJavaDocみたいなのを使うのが一番だよね。
概要設計レベルならUMLになるのかな？
でも、どっちも理解してくれないウチのPM…
まぁ何を書いても突っ返される訳だが（工数稼ぎのため？）
0068デフォルトの名無しさん
NGNGコメントをつけるとしたとき、仮引数名がその意味を完全に表していたときは
１．書かない
→UNDOCUMENTEDの警告がいつも出てしまってほかの警告が霞んでしまう
２．繰り返す：@param instance インスタンス
→かっこわるい
３．空にする：@param instance
→まちがってる気がする
どれがいいんでしょうか？
0069デフォルトの名無しさん
NGNG0070デフォルトの名無しさん
NGNG2
0071デフォルトの名無しさん
NGNG４．決めうち：@param instance ソース嫁
0072デフォルトの名無しさん
NGNG自分たちが書くべき言語で書かれた文書のこと。
それを読んで次の工程の人がその人たちが書くべき言語でコードを書く。
C言語で書かれたドキュメントをコンパイラに渡してそれを参考に
アセンブリコード或いは機械語コードに変換する作業をコンパイルと呼び
その作業をする人或いはソフトウェアをコンパイラと呼ぶ。
ソース：自分たちよりも前の工程の人が書いたドキュメント群のことを区別
する為にソースと呼ぶことが多い。
Javaでドキュメントを書いている人たちも、日本語のソースや英語のソース
を読んで書いている場合が多い。多くの場合、それは既にオンライン化され
ている場合が多く、Word・Excel等の上で読めるものであったりすることが多
い。
コード：自分たちの次以降の工程の人が書く文書はコードと呼ぶ。
0073デフォルトの名無しさん
NGNG良い会社・環境・人間関係という土台があってこそ
（続きどうぞ
0074デフォルトの名無しさん
NGNG724 名前： 文責：名無しさん 投稿日： 01/09/09 17:52 ID:Na9tEsUs
>>722
＞早朝番組の「占いコーナー」なんて、個人向けメッセージの宝庫かもしれないですね。
雑誌の占い欄もそうですね、以前も書いたけど。
「あなたの成果を横取りする人がでてくるかもしれません。その人の要領の良さに嫉妬しないで」
というアドバイスをある占いから頂きました。でも残念ながら，盗聴の要領の良さは嫉妬の対象になりません。
それに、成果を横取りするよりも、私にとっては、私生活の侵害のほうが遥かに腹立たしいです。
> 口では「マスコミの盗聴」に反対しながら、本音の部分では喜んでるんだろ、と思っている。
だから、盗聴に対する罪悪感がないのだ。その根底にあるのは、
女子アナ・芸能人というものに特別の価値があるという自惚れだ。
あはは、なるほど。そう言えば、盗聴やストーキング行為は、
かっこいい人にならされてもいいと言った、某マスコミ関係者がいたらしい。
された事ないから、わからないんだよね。それを聞いた人が
「なんだ、盗聴されても悪い気はしないんだ」と思い、罪悪感無く盗聴を続ける事になる。
いくら尊敬している人でも、かっこよくても（笑 盗聴がわかった時点で、信用は無くなります。
0075デフォルトの名無しさん
NGNG0076デフォルトの名無しさん
NGNG客が読んで役に立つのは要求仕様と運用マニュアルでは･･･
つーか、運用マニュアルって作んないのか･･･
0077デフォルトの名無しさん
NGNG仕様書ってのは何年後かに変更が発生した場合
自分たち（もしくはその修正を行う別会社）がどういう仕様か
確認するものだとおもてるよ
0078デフォルトの名無しさん
NGNG0079デフォルトの名無しさん
NGNGこのスレの文章読みづらいにだけど。
0080デフォルトの名無しさん
NGNGハゲ！
0081デフォルトの名無しさん
NGNG0082デフォルトの名無しさん
NGNGお勧めはありますか？
0083デフォルトの名無しさん
NGNG0084デフォルトの名無しさん
NGNG>> とか言うやつはアホだな。
・・と俺もかつては思っていた、が、ソースコードこそ唯一信頼ができる詳細設計書仕様書だと思うのだ
ＰＧはそれを理解して、可視性の高いソースコードをかかなければならない。
ここでも言われているが、関数仕様書等はdoxygen等でソースから自動抽出が最も実装との差異発生率が少なくて良い
フレームワークや外部仕様リンクの仕様もできればソースに組み込めればベストだと思うが
そのようなツールは現在この世にはない。
従って、クラス図とユースケース程度のものは、自前でドキュメントを残すべきだろう
ドキュメントを大げさにするのはコストの無駄である
ドキュメント作成にコストをかけた分だけ、また、メンテナンス時のコストが発生する。
また、次第に実装との差異が増加する率が高まるだけだ。
0085デフォルトの名無しさん
NGNG0086(゜Jし゜）
NGNGコメントに詳細仕様を記述しておいたので、後で暇人を
使ってコメントから仕様書を起草しましょう、と言ったところ、
「結局、ソースを読め！かよ。これだからPGは自分勝手な…」
「ドキュメントきちんと作って…困るんだよねぇ…云々｣
PMさん…コメントと自動生成のリファレンスだけでいいんです…。
ほんとに仕様書書く時間無いんですよ、助けてください。
0087デフォルトの名無しさん
NGNG「今時不勉強なＰＭは生き残れませんよ」って。
0088デフォルトの名無しさん
NGNG0089デフォルトの名無しさん
NGNG\anchorや\refいっこいっこ付ける方法しかないですか？
0090デフォルトの名無しさん
NGNG本質的には「どんな書類」が「いつ・どの期間」「誰に対して」必要なのかを明確にしておく必要があると思うのだ。
・外部仕様書
大抵の職業PG,SEはある程度規模が大きいソフトウェアを作るだろうから，少なくともマニュアルに近いもの，
一般的にはもっと詳細なものを最初に作るはずだと思う。
更に言えば，殆どの奴らは既存システムの改善（保守）をやっているので，既存の操作の変更があれば，最初に
どことどこを変更って決めたものを書いておかないとユーザ（またはマニュアル部隊）が困るはず。
ユーザに渡す前なら作った後でも良いし，正直最後に微修正が入ることもあるとは思う。
昔ユーザに「ソース読めば？」って言ったプログラマが居たが喧嘩になったよ。もうアホかと…
・詳細設計書
将来の誰かに対して残しておくってこともあるだろうけど，どこをどう直したかを書類としてのこしておかないと
ビルダー（パッケージング）する奴が困ると思うぞ。ちゃんとしたSEなら，どこを直したのか把握して全体の
調整もするはずだ。馬鹿SEも多いが，そういう書類を作って公開しておけば隣近所の奴が何やっているのかも
分かるしね。ソースから読めって奴もいるだろうけど，STABLE な状態ばっかりで開発できる羨ましい環境で
生活してんだなと思うぞ。
んじゃ。
0091デフォルトの名無しさん
NGNGすんごいローカル定義だこと。
0092(゜Jし゜）
NGNG書かせていたのでユーザには迷惑は掛かりませんでしたが…。
そしてそのPMは寄寓にもジャスト35歳だったりして。
結局、自分で書きましたよ、ええ。
後でメンテする人が困るし。
0093デフォルトの名無しさん
NGNGきみが書いた仕様書は、誰も解読できないと思うけどね・・・
0094(゜Jし゜）
NGNG痛いところを突きますね。
確かに自分の書いた仕様書は自分用のメモみたいな程度のもんでした。
でもまぁ無いよりはましかな、とか思ったもので…。
まーその辺の現実に目を背けたくてこんなスレにいるわけですが。
0095デフォルトの名無しさん
NGNGプログラマーとしてドキュメントはどんなものを書いていますか？
ウチは外注のソフトハウスで
ＰＭ・ＳＥは元請け会社がやっています。
元請け会社が作った、基本仕様書（仕様書とは名ばかりで、機能が羅列して書いてあるだけ）
を元にプログラムを書くのが
我々の仕事なのですが、
元請け会社に提出用のドキュメントや、
社内の人間に、自分が休んだり辞めたりした後に
他の人でも対応して貰えるように残しておくドキュメントとして
どんなものを作って（書いて）いますか。
ちなみに、今、私は一太郎でドキュメントをシコタマ書いていますが
ドキュメントを書く便利なツールやソフトって無いですか？
0096デフォルトの名無しさん
NGNGER図(これもツールで吸いだせるケース多し)と、DFDだけは残してください。
全文検索に引っかかりにくく死蔵になりやすいOffice文書も正直ｲﾔです。
009795
NGNGドキュメントの作成が、みんなマチマチで
ロクなドキュメントを残さないので、
「作った本人しかわかりません、触れません」状態になっており
休みの日にドラブルが起きると
家や携帯に電話が入る。
おちおち、休んでもいられない
杜撰な会社です
0098デフォルトの名無しさん
NGNG0099デフォルトの名無しさん
NGNGそれはロクなドキュメントじゃないから。
0100デフォルトの名無しさん
NGNGテーブルレイアウト図（って何だ？）を見たいと思った人間が、いちいちDBから吸いださずに
すむという理由で、テーブルレイアウト図（って何だ？）は存在しておいたほうがよい。
0101デフォルトの名無しさん
NGNGOffice文書がいやなら当然PDFもいやなんだろうが、だとするといったい何で書けと？
0102デフォルトの名無しさん
NGNGDBのテーブル毎にカラム名やキー、制約なんかを記述したドキュメントの事だけど。
テーブルレイアウトって言わない？これってローカル語なのか…ｽﾏｿ一般的には何て言うの?
DBからの吸出しは事実上ワンクリックで済む以上、手間では無いと思っているのだが・・・
>96
プレーンテキスト。あとはWikiかな。
もちろん、テキストだけで表現できない要素ならそれにはこだわりません。
OfficeやPDFだとどうしても見栄え的な部分へ力を割かなきゃいかんし更新の際に差分を
残しにくいのものも嫌いな理由の一つ。
あくまでも、内部用ドキュメントの話ね。外部に出すならワープロで作るのは構わないと思う。
0103デフォルトの名無しさん
NGNG0104デフォルトの名無しさん
NGNG読んでないのにろくなドキュメントかどうか分かるわけないだろう
0105デフォルトの名無しさん
NGNG0106デフォルトの名無しさん
NGNG>>104
0107デフォルトの名無しさん
NGNG誰も読まないからドキュメントを書かないでいると、必ずドキュメントを要求される。
0108デフォルトの名無しさん
NGNG書くと今度は誰も読まない。
0109デフォルトの名無しさん
NGNG> >100
> DBのテーブル毎にカラム名やキー、制約なんかを記述したドキュメントの事だけど。
> テーブルレイアウトって言わない？これってローカル語なのか…ｽﾏｿ一般的には何て言うの?
> DBからの吸出しは事実上ワンクリックで済む以上、手間では無いと思っているのだが・・・
ファイルとして保存しておけば、1秒もかからずに誰でも見始めることができるのだが。
> >96
> プレーンテキスト。あとはWikiかな。
> もちろん、テキストだけで表現できない要素ならそれにはこだわりません。
> OfficeやPDFだとどうしても見栄え的な部分へ力を割かなきゃいかんし更新の際に差分を
> 残しにくいのものも嫌いな理由の一つ。
> あくまでも、内部用ドキュメントの話ね。外部に出すならワープロで作るのは構わないと思う。
たぶんOfficeの使い方を間違っている。というか使いこなしていない。
Wikiで書いた文章を配布するときはどうするんだ？HTMLで配布するのか？
0110デフォルトの名無しさん
NGNGそのファイルが現物のDBを反映した物である保証があるならそれもアリですな。
>96
Officeに文書のバージョン管理の機能ってあるの?
是非教えてくれ。Officeを好きになれるかも。
配布に関しては別の話になると思うのだが・・・
まぁHTMLに吐くのもアリだしWikiによってはそのままPDF吐いてくれる物もあるし。
んで「テーブルレイアウト図」は一般的なんでしょうか。
気になって夜も眠れません・・・
0111デフォルトの名無しさん
NGNGぐぐってみりゃわかるだろうが。
日本語のページからテーブルレイアウト図を検索しました。 約6件中1 - 4件目 ・検索にかかった時間0.21秒
普通は「テーブルレイアウト」という。
0112デフォルトの名無しさん
NGNG>Officeに文書のバージョン管理の機能ってあるの?
少なくともWordにはある。
が、ファイルがどんどん肥大化するのでお薦めできない
0113デフォルトの名無しさん
NGNG0114デフォルトの名無しさん
NGNG開発した後、どんなドキュメントを残しますか？
0115デフォルトの名無しさん
NGNGカラムの名称や型や制約に関する記述はスキーマとかテーブル定義書って言うんじゃ
なかったっけ。テーブル間の関連を図示したものはＥＲＤだな。
0116110
NGNGあ、そういう事か。
図を抜く訳ね。
てっきり「一般的にはみかんと呼ばれる物を俺のところではりんごと呼んでいた」
くらい違うのかと思ってた。
今後気をつける。
0117デフォルトの名無しさん
NGNG当然相手に応じて。
言われなければ俺は
回路図とかの図面はPDFにして
テキストで書ける事は全部ソースに全部埋め込む。
0118112
NGNGどうやんのって、持ってるならヘルプ見れよ！！！
今回だけだぞ、
[ファイル]－[版の管理...]
0119デフォルトの名無しさん
NGNG0120デフォルトの名無しさん
NGNG0121デフォルトの名無しさん
NGNG0122デフォルトの名無しさん
NGNG0123デフォルトの名無しさん
NGNGあれってC++だっけ？
Doxygenレベルのlexerが単体で使えれば楽になることが沢山あるんだが・・。
0124デフォルトの名無しさん
NGNGwindowsのアプリ完成後のイメージを作成するのに、
簡単にコントロールぺタぺタできるのありませんかね？
ＶＣのダイアログボックスも、ＶＢのダイアログボックスもめんどくさいとこあるし・・・。
どなたか良いのありましたら教えてください。
0125デフォルトの名無しさん
NGNGその目論見書？
それにWindows の UI を乗せる必要がある？
0126デフォルトの名無しさん
NGNGレスありがとうございます。
なんつーんでしょうかね？まぁ、こんなん作りますがみたいなのを他社に送るもんらしいです。
まぁ、中身も当然ですがＵＩの使いかってがかなり重要っぽいので・・・。
もう、フリーハンドでもいいとおもうんですけどね・・・。
とりあえず、今回はまぁそれなりに書いたんでどね。
次回以降ワードあたりでしこしこ線引くのも疲れるんで、なんか楽なの無いかな？と思いまして・・・。
0127デフォルトの名無しさん
NGNG0128デフォルトの名無しさん
NGNGwxWindowsのGUIツールキットBOAとかFOXとかFLTKあたりで作成できないもんかと思って、
とりあえず、暇できたらなんか色々チャレンジしてみます。
でも、.NET対応流行ったらどうすっぺ・・・。
0129デフォルトの名無しさん
NGNGgtk+ 導入するのにものすごい壁がある。 Foxは知らん。
なんとなく実用的なものならwxWindowがいい、
でもどれでもポトペタは無理だと思う。
0130デフォルトの名無しさん
NGNG0131デフォルトの名無しさん
NGNG俺の会社の先輩はPowerPoint使ってデモしてました。
文字入力画面はできない(アニメーションでやってた)みたいだけど、
ボタンと画面表示はリンクで適当に作ってました。
全画面表示のアプリで、それっぽく見せてましたよ。
0132デフォルトの名無しさん
NGNG0133デフォルトの名無しさん
NGNGというか、そうでもして抽象化しないと完成画面だと思われる。
はっきりいえば、Windows の画面かどうかも分からないように書いたほうがいい。
0134デフォルトの名無しさん
NGNG0135124
NGNGみなさまどーもありとうございます。
>>129,132
ポトペタ（ポトッとおとしてペたって貼り付け？）は無理ですか。
ＶＢで適当につくるのがいいんですかね・・・。
でもおいらＶＢ苦手っす（なんかめんどいからかな？）。
超初心者用ページでいいページないですかね（スレ違い）。
C++ならそれなりにモウマンタイって感じなんですけど。
>>131
パワーポイントっすか。使ったことないですね。考慮してみます。
>>133
うーむ、画面設計書とかそこらへんの違いよくわからないです。
そういうのわかる書籍とかページありませんか？（スレ違い？）
とりあえず、今度は抽象化してだしてみますね。
>>134
あ、どもです。とあるページに載ってなかったもんでメジャーではないのかと思いまして。
（ここのＧＵＩスレには載ってますけど）
0136デフォルトの名無しさん
NGNGちょっとＰＭで設計書の類（まだはっきりしてないけど）を書く必要にせまられました。
で、役立つオススメな本あります？
0137デフォルトの名無しさん
NGNGなかったり、どうしようもないような代物なら…ガンガレ。
プログラム 設計書 で ぐぐると合うような物が見つかるかもよ。
0138デフォルトの名無しさん
NGNGなかったり、どうしようもない代物だったら…ガンガレ。
プログラム 設計書 でぐぐる
要求定義からやる羽目になる罠もあるのでその辺もひっかけておく。
0139デフォルトの名無しさん
NGNG＿|￣|○
0140(゜Jし゜）
NGNGこのへんどうよ？
http://pwiki.chbox.com/pukiwiki.php?siyousyo
http://bulkfeeds.net/app/search2?q=UML
0143デフォルトの名無しさん
NGNG0144デフォルトの名無しさん
NGNG0145デフォルトの名無しさん
NGNGダメ、それはプログラム設計書だNe!
0146デフォルトの名無しさん
NGNG0147デフォルトの名無しさん
NGNG激遅レスだけど、感謝です。
0148あげ
NGNG0149デフォルトの名無しさん
NGNG0150148
NGNGdoxygen+"two languages"でぐぐったらマニュアルの\ifディレクティブの項に書いてある事が分かった。
0151デフォルトの名無しさん
NGNG0152デフォルトの名無しさん
NGNG例えばメニュー名などはどういう括弧でくくるのか、単語末の長音はない
方がいいとか、会社とかによってルールとかはあるとは思うんですが…。
でもまちまちだとどこか新しい営業先に提案書持っていくときだの、いろんな
会社のマニュアルを保管する側とかとまどったりするんじゃないかと
思うのですが、みなさんは普通に自分の周辺ルールで書いてますか？
0153デフォルトの名無しさん
NGNG0154デフォルトの名無しさん
NGNG今までマニュアルや仕様書を（良い悪いに関わらず）読んできた経験に基づいて決める。
どこでも見かけるルールには従う。
あ、このルールいいな、と思ったものは取り入れてみる。
このルールだめじゃん、と思ったものは自分ではそうならないように気をつける。
ま、毒にも薬にもならん意見だな。
「ドキュメント」「標準」とかをキーに検索すれば？
0155デフォルトの名無しさん
NGNG先例でいい奴とかまねしてるが、業界として共通の表現とかって
どっかないんかな…
0156デフォルトの名無しさん
NGNG0157デフォルトの名無しさん
NGNG0158デフォルトの名無しさん
NGNG0159デフォルトの名無しさん
NGNG0160デフォルトの名無しさん
NGNG0161デフォルトの名無しさん
NGNGINPUT_FILTER使えば？
0162デフォルトの名無しさん
NGNGソースがドキュメント
0163デフォルトの名無しさん
NGNG0164デフォルトの名無しさん
NGNG0165デフォルトの名無しさん
NGNG俺のソースはきれいだと腐ったソースで自分に酔ってる厨と同じ。
0166デフォルトの名無しさん
NGNG（プロジェクトが）
0167デフォルトの名無しさん
NGNG0168Ruby!!!!!!!!!!!!!!
NGNGおまえらひれ伏せ。
0169デフォルトの名無しさん
NGNGドキュメントはソースだけで十分です。
#endif
0170デフォルトの名無しさん
NGNG○ドキュメントはソースだけしかありません。
0171162==163
NGNGいや、
おれが、ドキュメント書かないわけじゃないよ。
一応気を使ってdoxygen対応で書いてるぜ。
で、
わかりにくいドキュメント見るぐらいなら、ソース見るって感じ。
ドキュメント読んで信じて、騙されるぐらいなら
ソースを読んだ方が正確。時間もさほど変わらない。←これが俺ぐらいのレベル
ソースが汚い奴のドキュメントは、
やっぱりわかりにくい罠ってのもある。
一応、EffectiveC++レベル以上のその系統の書籍を数冊読んでるし、
汚いソース何個も見てきたので
ある程度の読みやすいソース書く自信あるぜ。
そういう本読んでない初心者ちゃんにはきついかも。
0172デフォルトの名無しさん
NGNGソース自体が読みやすいとか読みにくいとは全く別問題だし。
自分のソースにはバグは一切無いとか、
仕様のためのコードなのか、高速化のためのコードなのか、単にダメっぽいコードなのか、
みたいのを誰が見ても一目瞭然で区別できるとかいうなら話は別だが。
0173デフォルトの名無しさん
NGNG0174デフォルトの名無しさん
NGNG0175デフォルトの名無しさん
NGNG0176デフォルトの名無しさん
NGNG0177デフォルトの名無しさん
NGNG*.hにコメント書くよりも*.cppに書いたほうが良い、というのは理解した。
(そりゃそーだわな)
でも、DLLなどのバイナリライブラリでソース見せたくないときは、
*.hに書くしかないような気がする。
*.cppに書いてあったコメントが、あたかも*.hに書いてあったように
Doxygenできる方法ってあるの？
それともローテクにリリース寸前でコメントを*.hにコピペするんか？
0178デフォルトの名無しさん
NGNGまだまだ使い始めだからわかってないのかもしれないが、
要は、ソースが丸見えになるのがいやなのだ。
ソースを隠すオプションが探し切れていないだけなのかもしれん。
0179デフォルトの名無しさん
NGNGDoxygenした結果はcppに書いてあろうがhに書いてあろうが同じだと思うが。
ソース隠すオプションはある。
0180デフォルトの名無しさん
NGNGWindowsならDoxyWizard使うと楽チン。
0181デフォルトの名無しさん
NGNGすまんかった、いろいろ試してみたらソース隠せたよ。
DoxyWizardは知らんかった、ちょっとさわってみる。
0182デフォルトの名無しさん
NGNG0183ライブラリアン
NGNG書くものじゃないの。仕様書とか検査成績書とか。
プロはドキュメントを書いている時点で情報不足や矛盾が
わかるのでしょう。
プログラムを作ってからドキュメントを作るのは
最低だな。ゲーム少年の域をこえてないよ。
0184デフォルトの名無しさん
NGNG0185デフォルトの名無しさん
NGNG0186デフォルトの名無しさん
NGNG0187デフォルトの名無しさん
NGNG0188デフォルトの名無しさん
NGNGおいらのとこでは、プログラマが書くのは保守ドキュメントのほうが多い。
そうするとあとで書いたほうがいい。
同時にかくのはもっといい。
仕様書、成績書は別の人間が書く。
同じ人間がかくってことは零細？
0189デフォルトの名無しさん
NGNG0190デフォルトの名無しさん
NGNG書く順番の話をしているのでは
ということは188は読解力ゼロ？
0191デフォルトの名無しさん
NGNG0192188
NGNGプログラマの文書は保守文書が多かろうから
あとか同時に書くほうがいいし、あとが駄目とは
言い切れないんじゃないのということが言いたかった
ですよ。
んで、矛盾を見つかる仕様書は別の人が
書くだろうからそれで、非プロとはいかがなものかと。
>>189
悪くないけど大変ですね。
0193デフォルトの名無しさん
05/02/08 23:36:23doxygenのLaTeX出力は鬼門だな
ttp://www.atmarkit.co.jp/bbs/phpBB/viewtopic.php?topic=8354&forum=3&2
この辺のでｻﾝﾌﾟﾙは上手く逝ったが、漏れのソースだとｲﾋけ杉
0194デフォルトの名無しさん
05/02/09 15:13:57概念モデルで。
0195デフォルトの名無しさん
2005/04/09(土) 19:20:510196デフォルトの名無しさん
2005/05/08(日) 01:04:55int main(void){
char s[BUFSIZE]; //!汎用バッファ
↑こんなやつ。
0197デフォルトの名無しさん
2005/05/08(日) 01:11:53ローカル変数を廃止して、全部グローバルにすればOK？
0198デフォルトの名無しさん
2005/05/08(日) 01:14:38ｗｗｗｗｗｗｗｗｗｗｗｗおｋｗｗｗうはっｗｗｗ
うぇｗｗｗ
おｋｗｗｗっっおｋｗｗｗｗｗｗｗｗｗｗ
ｗｗｗうぇｗｗｗｗｗｗｗｗｗｗｗｗｗｗｗｗｗｗ
0199デフォルトの名無しさん
2005/05/08(日) 01:28:10おｋｗｗｗっっおｋｗｗｗっうぇうぇｗｗｗ
うはっｗｗｗ
っｗｗｗｗｗｗｗｗｗｗｗｗ
っうぇｗｗｗｗｗｗ
うはっｗｗｗっうぇｗｗｗｗｗｗｗｗｗｗｗｗｗｗｗ
0200デフォルトの名無しさん
2005/05/08(日) 23:37:07そんなもの出力する必要あるの？
0201デフォルトの名無しさん
2005/05/08(日) 23:48:31変数のドキュメントは必要でしょー
0202デフォルトの名無しさん
2005/05/08(日) 23:50:12doxygenって、関数やクラスのインタフェースを記述するためのものじゃないの？
0203デフォルトの名無しさん
2005/05/09(月) 11:15:06きめつけ：(･Ａ･)ｲｸﾅｲ
0204デフォルトの名無しさん
2005/05/09(月) 11:27:33ローカル変数ってのは隠蔽されるべきものなので、
皆が読むドキュメントには書くべきではないと思われ。
実装者とか保守する人用に注意書き程度にコメント書くなら構わんと思うけど。
0205デフォルトの名無しさん
2005/05/09(月) 11:54:51じつわ
ぜんぶmadeinusa
なので
それを
にほんごにするときに∞∴♂♀℃￥＄￠￡％＃＆＊＠§☆
0206デフォルトの名無しさん
2005/05/09(月) 12:07:04おｋｗｗｗうはっｗｗｗｗｗｗおｋｗｗｗ
ｗｗｗｗｗｗｗｗｗｗｗｗ
っうぇ
ｗｗｗｗｗｗｗｗｗｗｗｗ
うはっｗｗｗおｋｗｗｗｗｗｗｗｗｗｗｗｗｗっうぇ
0207デフォルトの名無しさん
2005/05/10(火) 00:19:54保守用ドキュメントを作成し
0208デフォルトの名無しさん
2005/05/10(火) 02:08:45普通は意味無いので
0209デフォルトの名無しさん
2005/05/10(火) 02:30:03ｗｗｗｗｗｗｗｗｗｗｗｗｗうはっｗｗｗｗｗｗｗｗ
ｗｗｗっｗｗｗｗｗｗｗｗｗｗｗｗｗｗｗ
おｋｗｗｗ
うはっｗｗｗｗｗｗうぇｗｗｗ
ｗｗｗｗｗｗｗｗｗｗｗｗ
0210デフォルトの名無しさん
2005/05/10(火) 03:33:47おｋｗｗｗうぇｗｗｗｗｗｗｗｗｗｗｗｗｗｗｗうはっｗｗｗ
うぇｗｗｗｗｗうはっｗｗｗｗｗｗｗｗｗｗｗｗｗｗｗ
ｗｗｗｗｗｗｗｗｗｗうはっｗｗｗｗｗｗうぇｗｗｗ
0211デフォルトの名無しさん
2005/05/11(水) 08:37:360212デフォルトの名無しさん
2005/05/11(水) 20:58:440213デフォルトの名無しさん
2005/05/12(木) 09:26:540214デフォルトの名無しさん
2005/05/12(木) 22:50:480215デフォルトの名無しさん
2005/05/13(金) 09:19:260216デフォルトの名無しさん
2005/05/13(金) 18:14:500217デフォルトの名無しさん
2005/05/15(日) 00:34:54ソースのひな形つくってdoxygenか？
なんか綺麗な方法ないか探し中の俺に教れろ。
0218デフォルトの名無しさん
2005/05/15(日) 01:00:180219デフォルトの名無しさん
2005/05/17(火) 01:13:370220デフォルトの名無しさん
2005/06/07(火) 00:18:400221デフォルトの名無しさん
2005/06/12(日) 01:55:490222デフォルトの名無しさん
2005/06/12(日) 12:15:26つーか、いねーよそんな奴(ﾌﾟｹﾞﾜﾛｳｽ
0223デフォルトの名無しさん
2005/06/12(日) 14:45:09目的はdoxygenにリンクさせて、一括管理しようと思ってます。（名づけて一元化）
WORDで作るとhtmlじゃなくhtmってなって、WORDで開いて.docにも変換可能です
質問はhtmって一般常識として普及しているのかどうかです
みなさんは、仕様を書くソフト（拡張子）は何を使ってますか？
0224デフォルトの名無しさん
2005/06/12(日) 14:51:50テキストで管理して変換変換
.txt→.htm→.pdf と
0225デフォルトの名無しさん
2005/06/12(日) 15:10:03なるほど、テキスト最強ですな。
でもページ上でリンクしたいから、テキスト厳しいかも。
変な表とか入れずに、互換性上げるのには気をつけてます。
0226デフォルトの名無しさん
2005/06/12(日) 15:29:56htmlをWORDで作るってのが個人的には好きではないが。
htmlは電子文書としては最強の一つだと思ってるよ。PDFよかぜんぜん好き。
仕様書は紙で出してナンボと思ってる古い業界体質も残ってるから
ウケはあまりよくないかも知れないけどね。
0227デフォルトの名無しさん
2005/06/12(日) 18:54:41どうせならもっと徹底して、テキストを完全に分離して欲しかったなぁ
テキスト側はもう生txtそのままでさ、
スタイルシート側は、面倒でも行で指定する感じ
実際は簡単なツールで補えば、行指定やテキスト変更も、手間でも無いだろうし
0228デフォルトの名無しさん
2005/06/12(日) 19:41:15行指定は面倒すぎだろ
あと、その概念はWord文書みたいだ
0229デフォルトの名無しさん
2005/06/12(日) 20:26:40確かに両方用意しないと行けない場合に便利だな。
頭の固いおっさん向けに、紙に印刷する必要がある時とか。
0230デフォルトの名無しさん
2005/06/12(日) 23:17:560231デフォルトの名無しさん
2005/06/13(月) 01:14:18自分ならdoxygenでRTFで出力してpdfに変換して添付ファイルにするか、
WORDでRTFを開いてDOCに保存しなおすか。
RTFだとリンクはそのまま残るし、ドキュメントとしてもそれなりに
綺麗に出力されるからお勧め。一度試してみれ。
0232デフォルトの名無しさん
2005/06/13(月) 01:22:28それでお客に納品するの？
おいらは、Visioやパワーポイントも使わないようにしてるけど
打ち合わせ資料で使うときあるけど、最終的にはエクセルで書き直す事になる
0234デフォルトの名無しさん
2005/06/13(月) 03:52:03XMLに対応したコンパイラ
0235デフォルトの名無しさん
2005/06/13(月) 11:35:27XMLってマジで言ってますか？
0236デフォルトの名無しさん
2005/06/13(月) 20:30:41XSLT使えばどうにでもなる気がする
0237デフォルトの名無しさん
2005/06/14(火) 13:26:23「文芸的プログラミング」(literary programming)
つーのを提唱して WEB つーシステムを開発したよね
それやりゃいいんだろ
0238デフォルトの名無しさん
2005/06/14(火) 21:01:39,r" .,/i、 .ﾍ, ｀ヽ、
､" ./::::::i, /ヽ l..:::i, . '、
/ .,/:::::::::::i /.,:::l i::::::::i 、 ヽ
/ .,、.,i:::::::::::::::i, /:::::::::v,,:::::::::l, ,li i
│ /:l./::::i::::|l::::::V,:::::::/i:::::::ﾍ::::::V::l, . | ,.,..,,.,..､、
| ./:::l:::::::l-i:|-!::::::::::::::/ 'l:::/--l::::::;;;;l ..ﾚ'"´
l .i::::::::::::l-i-'｡.ヽ::::::::/ ´l/-｡､i:::::::::::! ..i 可 理
'!l:::::::: ﾍl |::::::l` i:::::/ ｲ::::::| ,!/::::::. i | 能 論
i::::/i::::l,｀ ￣｀ Ｖ ￣ i::::i::::./ な 上
V l::::l, J /::::i "i/ ん は
ﾞl:::＼ ＿＿ ./l:::/ で
'!/ ヽ._ ヽ ﾉ ,／" iv す
＿.|｀ヽ- -イ|＿ ＜ ﾟ
,,､ノ;;;;;;;||||| |||||;;;;;;;ヽ.｀!
SmartDocみたいな使えないものになるのが落ち
0239デフォルトの名無しさん
2005/06/26(日) 01:01:12基本設計書からすべてExcelだ（´･ω･`）
確かに図を書くのがラクだけど・・・
0240デフォルトの名無しさん
2005/06/26(日) 17:00:24Wordでもなんでもいいと思う
0241デフォルトの名無しさん
2005/06/26(日) 17:48:03おれ、ワードは線がずれたら直せないんだよ。
0242デフォルトの名無しさん
2005/06/26(日) 17:52:50根性、根性、ど根性
ちなみにIMEだと ど根性 で一単語になってる
0243デフォルトの名無しさん
2005/06/27(月) 03:53:010244デフォルトの名無しさん
2005/06/27(月) 12:39:170245デフォルトの名無しさん
2005/06/28(火) 11:06:46FEPって方が通りがよかった。
だからついMS-IMEの事をIMEといってしまうま。
0246デフォルトの名無しさん
2005/08/21(日) 20:15:270247デフォルトの名無しさん
2005/08/22(月) 09:31:21俺の場合
図や表、文をまぜこみの仕様書である程度見栄えも気にする場合は、
OpenOfficeOrg2.0Betaを使っている。
Wordは俺は受け付けることができなかったが、Oooはなんとか好きになれそう。
htmlでやっているって言う人は、テキストエディタでごりごり書いているのだろうか？
ま、それが一番書きやすいのだが、そろそろhtmlエディタで良いのが出てきてほしいなあ。
0248デフォルトの名無しさん
2005/08/22(月) 19:05:24Wordは俺のUIと合わなかった
0249デフォルトの名無しさん
2005/08/27(土) 15:18:42挙動不審な事が多いし良く落ちるがドキュメントやマニュアルを書くのにはやっぱ
エクセルよりワードだな。
0250デフォルトの名無しさん
2005/09/03(土) 13:55:02プログラマのためのワード講座
みたいなスレを立ててみようか
使いにくいと文句をいっている人は
例えるなら秀丸でVC++のソース編集してるようなもので
きちんと環境構築と突然死への備えを整えれば
VisualStudioなみの便利さを手に入れることはできる
0251デフォルトの名無しさん
2005/09/10(土) 01:05:560252デフォルトの名無しさん
2005/09/10(土) 04:56:03Windowsでエクセル（ ﾟдﾟ）ﾎﾟｶｰﾝ
社内通達がエクセルで回って来た事もある。本文無しで添付ファイル
があるだけという、思わずゴミ箱に放りそうになったぞ。
それはそれとして、前に文章作成なのに何故エクセル？という問いを
投げてみたんだが、エクセルで何の問題がある？と聞き返されて有耶
無耶になった。
ワードを使えば云々と言えるほど、俺はオフィスツール知らんからな。
て言うか、正直エクセルも線の引き方と文字の属性変更くらいしか知
らんのだけどねorz
誰もが納得するワードの利点とかあるなら聞きたい＞250
0253デフォルトの名無しさん
2005/09/10(土) 08:15:48おぢさん達はExcelが大好きなのです。
日々の報告書からプレゼン資料まで、全部Excelで作ってくれます。
Wordは勝手に整形しやがるから使いにくいそうです。
罫線使いまくりの日本語文書はExcelの方が使いやすいんでしょう。
250じゃないが、誰もが納得するWordの利点： （取引先も含めて）みんなが使ってる
0254デフォルトの名無しさん
2005/09/10(土) 09:31:46分厚い仕様書を方眼紙みたくしたエクセルで書かされて
目次の管理で死にました。
0255デフォルトの名無しさん
2005/09/10(土) 15:11:30スタイル
なぜかあんまり使われていないようですが……
0256名無しさん＠そうだ選挙に行こう
2005/09/10(土) 19:01:51エクセルだと表計算と図と文章作成、全てエクセル
でやろうと思えば済んでしまうらしいので、プレゼン資料
とかも全部エクセルだけにしてる奴がたまにいるｗ
0257名無しさん＠そうだ選挙に行こう
2005/09/10(土) 20:13:54みんなが使ってる度ならExcelの方が上じゃない？
少なくともWordの方が一方的に有利って事はないと思う。
>>255
初めて聞いたｗ
>>256
最近、MindManager(MindMap)が大人気。
少し前はEA(UseCase)が大流行だったが
次は何が流行るんだろう？
0258名無しさん＠そうだ選挙に行こう
2005/09/11(日) 00:56:45Wordのスタイル、少し覚えてみなよ。
マジデ便利だから。
0259名無しさん＠そうだ選挙に行こう
2005/09/11(日) 01:08:00インストールして5年は経っているが、たぶんこれが起動2回目くらいだな
んでしばらくイジくってみたんだけど、テキストボックス使えればOKな感じでいいのかね？
他にめぼしい機能あるかな。些末なの抜きで。
0260名無しさん＠そうだ選挙に行こう
2005/09/11(日) 03:38:57>些末なの抜きで。
Wordの売りはむしろ些末な機能が豊富にあるとこかもしれんｗｗｗ
0261名無しさん＠そうだ選挙に行こう
2005/09/11(日) 03:40:38迷惑な便利機能を殺したくてその便利機能について学ぶという不毛な時間がすごくアレだ
0262名無しさん＠そうだ選挙に行こう
2005/09/11(日) 04:01:28パワポは俺も最近までは全然評価してなかったんだけど、会議で使う資料をパワポで作ったら、
いつもテキストファイルで書いてる内容と変わらんのに、妙に内容の評価がよくてﾜﾗﾀ。
やっぱり人は体裁で騙されるもんだなｗｗｗ ・・・それからはパワポに一目置いている俺ｶﾞｲﾙ。
0263名無しさん＠そうだ選挙に行こう
2005/09/11(日) 11:27:31発表において、体裁ってもんがどれほど重要か。
どんな小手先の技でもいいから、人の気を引くというのは大切よ。
Word の利点、ぱっと思いついたのだと、
- 修正履歴を残せる → 学生の論文チェックとかかなり楽
- コメントを付けれる → これも校正に凄く便利
- スペルチェック → 英文はとりあえず最初 Word で書いとけみたいな
- 一応、段落ごとにスタイル定義しておいて、スタイルの書式変更したら同じスタイル一斉に変更される
0264名無しさん＠そうだ選挙に行こう
2005/09/11(日) 13:27:47スタイルとかクロスリファレンスつけておくとマジ便利
目次や索引も自動で作れるし。
これでもう少し図形描画の機能が充実してればなぁ・・・
ま、そっちはVisio使ってるからいいんだけど。
#でも、個人的にはLaTexを吐いてくれるエディタが欲しいところ
0265名無しさん＠そうだ選挙に行こう
2005/09/11(日) 13:29:26- 目次作成 + 自動更新
- 図表番号の自動更新
0266名無しさん＠そうだ選挙に行こう
2005/09/11(日) 17:20:24どれも俺からすると些末な機能なんだけど。
XSLTが大好きな俺的にはXML形式に対応してるところなんかが蝶最高なんだけど、
これはExcelやパワポでもできることだしな。
0267名無しさん＠そうだ選挙に行こう
2005/09/11(日) 17:33:54多数派であるということ
0268名無しさん＠そうだ選挙に行こう
2005/09/11(日) 17:50:31最近のはマシなんか？
Wordでページ数多い文書作ると重いわすぐ落ちるわで……
いい印象無かったんだが
0269名無しさん＠そうだ選挙に行こう
2005/09/11(日) 18:28:11この辺のテンプレート集とかスクリプト集ってある？
折角の利点も簡便で分かり易くないと説得が難しい。
偉いさんてのはプライドを刺激されると意固地になるからな。彼らは難しいとか
理解できないを決して口にせず、それらを必要がないの一言で片付けてしまう。
0270名無しさん＠そうだ選挙に行こう
2005/09/11(日) 18:32:51Excelの方が多数派だよ？
総務などの非生産部門には必ずと言っていいほどExcelが導入されてるから
0271名無しさん＠そうだ選挙に行こう
2005/09/11(日) 18:33:14目次だのなんだのって、単なるWordの基本機能だから、スクリプトは不要だよ。
ちゃんとスタイル使って（「見出し1」とか「見出し2」とか）文書を
書けば、章番号を自動で振ってくれるし、後でそれをもとに自動で目次が作れる。
0272名無しさん＠そうだ選挙に行こう
2005/09/11(日) 18:34:18ExcelとWordでは用途が違うというだけの話だ。
適材適所で使い分けるのが賢いやり方。
0273名無しさん＠そうだ選挙に行こう
2005/09/11(日) 18:51:04ありゃ？そうなのか、て言うか基本機能なのかよ！
俺自身が実際に触って、基本機能くらいは理解しないと話にもならんな＿|￣|○|||
それが何とも億劫と言えば億劫なんだが……
俺も偉いさんの事をとやかくは言えんな……
>>272
問題は、決して賢くないという点だ！Σ(´Д｀ ）
0274名無しさん＠そうだ選挙に行こう
2005/09/11(日) 19:02:01http://www.amazon.co.jp/exec/obidos/ASIN/4774117501/
この本がおすすめ。
アウトラインモードで取り敢えず書くのが
自然に思えてきたら結構使ってる人なんじゃないでしょか。
0275名無しさん＠そうだ選挙に行こう
2005/09/11(日) 21:47:06俺、元々LaTeX派だったけど、3日でWordに転向しちゃったよ。
割とすぐ覚えれる。
0276名無しさん＠そうだ選挙に行こう
2005/09/11(日) 21:50:52この本、自分も人から薦められて買ったけど、かなりいい本ですね。
職場に一冊常備すべし。
0277名無しさん＠そうだ選挙に行こう
2005/09/11(日) 22:54:180278デフォルトの名無しさん
2005/09/12(月) 00:35:07ホントかよ？ジエリじゃねぇだろうなｗ
とりあえず明日本屋行ってくるよ。初心者向けではないみたいだから
一緒に入門書も買ってくる。
0279デフォルトの名無しさん
2005/09/12(月) 00:59:59じえんじゃないよ。
まあじえんだとしてもいいじゃん
本屋で立ち読みしてみて決めてちょー。
カラーページがないところとかが硬派で
それだけで好感が持てますだ。
DTPのマナーみたいな話も、システム文書には
必要ないけど、面白かったな。
0280デフォルトの名無しさん
2005/09/16(金) 00:55:41特にスタイル使わずに書かれた文章にスタイルを導入しようとすると死ねる。
0281デフォルトの名無しさん
2005/09/16(金) 10:45:36あとからは相当骨でしょそりゃー。
0282デフォルトの名無しさん
2005/09/23(金) 00:26:28俺はかなり良いソフトだと思うんだけど。いやマジで。
今までアドビのフレームメーカーとかロータスのワードプロも触ってきてるけど
ワードのUIはそれらより飛びぬけて直観的だし、機能も多い。
ワード使い難いって奴はフレームメーカー使ってみるといいかも。
フレームメーカーの糞UIはマジで殺したくなるよ。それでいてワードより高かったりしたから恐れ入る。
まあでも時々挙動不審だったりするし、段落番号の設定みたいに異常にわかり難い
UIがあったりする欠点は確かにあるな。
それにしても、ワード貶してる奴らに関しては、ワードの問題というより
そいつらの能力の問題じゃないかと思うが。
0283デフォルトの名無しさん
2005/09/23(金) 01:07:59UNIXが使いにくいのとおなじ
0284デフォルトの名無しさん
2005/09/23(金) 11:01:41そいつらの能力の問題じゃないかと思うが。
0285デフォルトの名無しさん
2005/09/23(金) 14:04:570286デフォルトの名無しさん
2005/10/10(月) 16:31:55そりゃ無能だろ
0287デフォルトの名無しさん
2005/10/10(月) 17:27:01UNIXはどうしようもないからな。
0288デフォルトの名無しさん
2005/10/10(月) 17:33:250289デフォルトの名無しさん
2005/10/10(月) 17:34:07Wordの使いにくさは 袋小路 であり、UNIXの使いにくさは 迷路 だ。
Wordでやりたいことをやるとき、正式な方法が無いことはよくあり
正式じゃない方法で突破することが多い
UNIXでやりたいことをやるとき、正式な方法がそもそも難解で
そのことを訴えると「道があるんだからいいだろ」と突っぱねる
0290デフォルトの名無しさん
2005/10/10(月) 18:29:51Wordはなー。MSってUIにけっこう力入れてるはずなのになんであんなことになるのか。
0291デフォルトの名無しさん
2005/10/10(月) 19:38:350292デフォルトの名無しさん
2005/10/11(火) 11:07:21PHPのドキュメンテーションなんていい例じゃないかな。
使い方系のドキュメンテーションはシナリオ書いとく。
ところで、結局Wiki立てても書くのは結局一人だけだよなぁ。
でもみんなで書くという機能よりも手軽にどこからでも書けるというのが気に入ってる。
使いこなすとかなり快適。あとはVISIOでちょっと図を描いて終了。
0293デフォルトの名無しさん
2005/10/27(木) 03:40:16動作例ある方が読みやすいもんな。
つーか動作例無いと、リファレンスに見えないというか。
0294デフォルトの名無しさん
2005/11/01(火) 01:47:400295デフォルトの名無しさん
2005/11/06(日) 15:48:48細かい仕様はソースにコメント埋めまくり。
ワードとかUNIX使いこなせない香具師はスキル低いだけ。
何か一つだけしか覚えられない香具師がエクセル使っている感が有るな。
自由紙、原稿用紙、レポート用紙、方眼用紙っていろいろあるけど、どれか一つ選べって状態で方眼紙選んじゃってるだけだ。
レポート用紙にグラフも書けるのにさ。
0296デフォルトの名無しさん
2005/11/11(金) 16:36:53つーか、こんだけソフト開発が行われてるんだから、もちっとドキュメント作成技術も洗練されていてくると思うんだけどな～。
どこのプロジェクト行っても、読まれない＆読んでも意味ないドキュメントばっか。
新規で起こす時も役にたたねぇだろうなーと思いつつ作ってるし。
それともオレが知らないだけで、既に良いツールor作成理論とかあったりするの？
もしあったら教えてエロイひと
0297デフォルトの名無しさん
2005/11/11(金) 22:53:22コツを教えてあげるよ
自分が欲しいと思えるドキュメントを作ればいいよ
役に立つように作るべし
役に立たないと思った個所はどんどん削除
0298デフォルトの名無しさん
2005/11/11(金) 22:55:250299デフォルトの名無しさん
2005/11/11(金) 23:11:010300デフォルトの名無しさん
2005/11/11(金) 23:23:41普通のアプリでWikiっぽい機能＋Wordの章番管理＋Excelみたいな表が
自由に作れる幹事で
0301デフォルトの名無しさん
2005/11/12(土) 08:19:16この関数は○○の機能を持つ <- 起結
ただし、××の副作用を持つ <- 承転
0302デフォルトの名無しさん
2005/11/12(土) 17:11:510303296
2005/11/14(月) 09:43:53この業界、結局ウォーターフォール型がほとんどじゃない？
だったら 要求＞仕様＞設計＞試験 ぐらいのテンプレートとか支援ツールあってもいいんじゃねーかなと思って。
それに有名な規格ができたら、顧客の理解度、満足度ももっと高くならないかなぁ。とか
（Rational Rose とかは勘弁な。”UML図”だけじゃレビュー通らないし）
あと変に思うのは設計書。実装イメージをそのまま文書にしたのをよく見かけるけど、設計書は利用者ガイドであるべきだと思うんだ。
あの高いソフト買うと付いてくる大量のマニュアル郡みたいに、コンセプト、概要、実装サンプル、注意点、とか。
設計者が変わりに文書で実装しても意味ないっしょ。
あ～ぐだぐだと駄文書いてスマヌ
0304デフォルトの名無しさん
2005/11/14(月) 10:41:15納品物としての仕様書なんかいらん。読んでくれないし。
きっちり書いたユーザーマニュアル納品すれば一番ブレがない。
要求は全てそこに落とせばいいんじゃないかなあと。
だからマニュアルといっても画面の説明だけじゃなくて
半分業務マニュアルって感じ。
所謂仕様書らしい仕様書は、
お客さんにガッチガチの情シスがあって
そこが出せっていうんだったら書くよ、って感じで
いいんじゃないでしょうか。
なんか仕様書とあまり変わらないか。
でも言葉とかフォーマットとか、もっとお客さんに優しい感じ。
0305デフォルトの名無しさん
2005/11/14(月) 13:50:36質重視ではなく量重視だな。
0306デフォルトの名無しさん
2005/11/14(月) 15:40:39マニュアルでの納品がやっぱいいな
スクリーンショットわんさかで
0307デフォルトの名無しさん
2005/11/14(月) 21:10:06そんな感じ
注意事項
0308デフォルトの名無しさん
2005/11/15(火) 01:24:59マニュアル + クラス仕様書(自動生成したもの) が最強。
そして両面印刷なんてもってのほか。
0309デフォルトの名無しさん
2005/11/29(火) 03:00:58亀レスすまそ。
よくExcelのセルを方眼紙みたい（正方形）にする人がいるんだけど、
あれって何が便利であんなセルにしちゃうわけ？
レイアウトしやすいってだけ？
0310デフォルトの名無しさん
2005/11/29(火) 10:04:30あと、インデントしやすいからといってた。
0312デフォルトの名無しさん
2005/12/31(土) 19:33:110313デフォルトの名無しさん
2005/12/31(土) 20:00:13リンクやレイアウトが簡単だし、ブラウザは誰でも入ってるから。
0314デフォルトの名無しさん
2006/01/25(水) 17:59:27みたいなコマンド(キーワードや記法)が多いと思ったんだけど、どう？
おまいらのdoxygenボキャブラリーはどんなもんよ？
0315デフォルトの名無しさん
2006/01/25(水) 22:45:51pre post param return retval
後メンバグループにname { }
0316デフォルトの名無しさん
2006/01/27(金) 09:26:58それだけあれば、ひととおりの仕様は説明できそうだよね。
「意見」なんかを入れはじめるとややこしくなるんだよね。
0317デフォルトの名無しさん
2006/02/25(土) 02:38:32自分ではわかってるけど説明するのが下手というやつは、自分でも
わかってない。それは直感と連想能力とヒントでピントでプログラミング
してるだけだ。
0318デフォルトの名無しさん
2006/02/25(土) 11:59:02ドキュメント作成なんてまだるっこしくってやってられんのだろうな。
馬鹿の気持ちが分からないから、標準からはずれたのを作成してしまう。
医者なんかでもそうだけど、臨床とかエンドユーザーが絡む作業は
あんまり頭が切れるヤツは向いてなくて、
ちょっと馬鹿だけどそれを自覚して慎重・着実に作業する
ヤツの方が向いてる。
0319デフォルトの名無しさん
2006/03/04(土) 02:25:09各工程で何の文書が必要で、どのような項目を記載するものだ、みたいな
0320デフォルトの名無しさん
2006/03/32(土) 17:58:17客側に上級シスアドみたいなのがいれば話は別だが、現在ではそんな状況はあまりない。
結局UMLで書くってのは設計者のオナニーなんだなと思う。
なにしろUML試験なんかあるくらいだから、コンピュータど素人のお客にわかりやすいわけがない。
ところでXP開発におけるドキュメントの生成の仕方ってどうしてる？
うちは要件定義書が文章じゃなくて業務フローのの図だけなんだが。
そんなのが入力では詳細設計書なんて書けないぜ。
0321デフォルトの名無しさん
2006/03/32(土) 18:31:53なんて言ってる人はあなた以外に見たことありませんけどw
自分が勝手に銀の弾丸を求めてるだけでしょ？
銀の弾丸がきっとあるに違いないと無意識に思ってるから
ネジ廻しがネジを締めることにしか使えないことに苛立つんだよ。
0322デフォルトの名無しさん
2006/03/32(土) 18:57:02＞なんて言ってる人はあなた以外に見たことありませんけどw
見聞が狭いんだね。俺は何人か知ってるよ。
見たこともない、とは重傷だな。
0323デフォルトの名無しさん
2006/03/32(土) 20:35:16ポイントが抑えられてないような。
UMLだろうがワードだろうが、同じ人間が書く限りダメなドキュメントなのは変わらないのが現実
0324デフォルトの名無しさん
2006/03/32(土) 23:02:480325デフォルトの名無しさん
2006/04/09(日) 00:06:13Qtスタイルにしてます？JavaDocスタイルにしてます？
0326デフォルトの名無しさん
2006/04/09(日) 17:17:32Qt ってマイナーだし Qt にするメリットってあるの？
0327デフォルトの名無しさん
2006/04/09(日) 20:37:45むつかしく書きすぎ、細かく書きすぎ
なんじゃないの？
0328デフォルトの名無しさん
2006/04/09(日) 21:42:04伝えるだけなら、
紙に手書きしてコピったりスキャナで取り込むなりの方が遥かに敏速。
0329デフォルトの名無しさん
2006/04/10(月) 03:00:04それこそ本屋にいけば山ほどその手の本があるやん。
成果物が一番はっきり明示されているのはラショナル統一プロセス
じゃないの。ISO9001なんかを取得している会社なら社内標準で
成果物が設定されているでしょ。
>>320
オブジェクト指向言語で開発しているなら、それとの親和性の
高さという点から、内部設計はUMLでするのはいい。けど、
要求仕様をユースケースなんかで顧客に見せるやつの気が知れない。
というかそういうやついるのか？俺はずっと前からアンチユース
ケース派でそういうことばっかり言っているけど。
0330329
2006/04/10(月) 03:02:49それと追記するけど、どんな職場や環境、メンバーのスキルに
合致した魔法の世界標準フォーマットは存在するわけがない。
それぞれに合致したものはそれぞれが苦労して考えるしかない。
参考にするのはいいけど、巷に出回っている開発プロセスを
そのままやろうとすると失敗するよ。
0331デフォルトの名無しさん
2006/04/18(火) 15:12:14仕様書だけ書いて、それを
ベクターみたいに、アップロードして
みんなに見せるサイトって、どこかある？
0332デフォルトの名無しさん
2006/04/18(火) 15:15:33良いドキュメント・マニュアル・仕様書を書くスレ
http://pc8.2ch.net/test/read.cgi/tech/1065364445/
小規模開発では仕様書は作るだけ無駄
http://pc8.2ch.net/test/read.cgi/prog/1125913671/
AJAX時代の仕様書とは
http://pc8.2ch.net/test/read.cgi/tech/1140766471/
営業が作った仕様書に
http://pc8.2ch.net/test/read.cgi/prog/1121256149/
良い仕様書、悪い仕様書、普通の仕様書
http://pc8.2ch.net/test/read.cgi/prog/1143906019/
プログラマ経験がないのに仕様書を作成
http://pc8.2ch.net/test/read.cgi/prog/1119776686/
仕様書の量でしか成果を決められない客
http://pc8.2ch.net/test/read.cgi/prog/1143878620/
Excelで仕様書を作る会社の奴の数→
http://pc8.2ch.net/test/read.cgi/prog/1137662854/
0333デフォルトの名無しさん
2006/04/19(水) 02:18:12HIDE_UNDOC系のタグをYESにしててドキュメント付けした要素だけ
書き出してるんだけど（もちろんEXTRACT_ALLはNO）
\fnとか一行コメントとか付けてない関数を強制的にドキュメントに含めてよ！
って指示するコマンドありますか？
今は全角空白の一行コメント付けて無理やり出してるんだけど
リスト表示のとこで無駄に下に空白ができちゃってみづらいんです
（同じページに列挙したいけどわざわざコメント付けしたくない関数ってのがいっぱいある）
0334sage
2006/04/28(金) 11:10:03その前に設計仕様書があるべきだと思うんですが、
DoxygenやJavaDocで出したものを、仕様書にするってことは
それ以前にモジュール設計仕様書とか無いままコーディング
してるんでしょうか？
0335デフォルトの名無しさん
2006/04/28(金) 12:19:210336デフォルトの名無しさん
2006/04/28(金) 13:07:440337sage
2006/04/28(金) 13:21:18そりゃ、設計代もらってるんだからやりますよ
フリーソフトウェアの開発者とかなら話は別ですが…
0338デフォルトの名無しさん
NGNG0339デフォルトの名無しさん
2006/04/28(金) 17:09:48>コーディングは製造であって、
違います。
- コーディングは設計作業です
- ソースコードは設計成果物です
- コンパイル・リンクなどが製造工程になります
0340デフォルトの名無しさん
2006/04/28(金) 17:25:010341デフォルトの名無しさん
2006/04/28(金) 21:56:05幸せだなぁ…
そう思ってるうちはコーダーから卒業できんよ
0342デフォルトの名無しさん
2006/04/28(金) 22:45:00２００７年をめどに完成予定とか。
どうなるのかな？
0343デフォルトの名無しさん
2006/04/29(土) 04:30:26コーディングは、ラインの設計だ。
0344デフォルトの名無しさん
2006/04/29(土) 10:24:490345デフォルトの名無しさん
2006/04/29(土) 21:31:40メタファの章はよくまとまってるよ
0346デフォルトの名無しさん
2006/05/01(月) 20:45:13俺は個人的にちまちまいじってるぐらいです。
みんなに使ってもらうにはやはり雛形を作成するしかないけど
どんなのがいいのか思案中。
なにかサンプルと成るものってあります？
0347デフォルトの名無しさん
2006/05/01(月) 20:49:42Doxygen 自体
libstdc++
Subversion
いっぱいあるよ。
っていうか、雛形なんか要らないと思うけど。
0348デフォルトの名無しさん
2006/05/01(月) 20:54:11そりゃヘッダに実装も書いてあるんだからそこにコメント付けるのが自然かもしれんが
各テンプレートの間にミッチりコメントが詰まってソースコードとして読みづらくなる（困
こういうときってコメントだけの空cppファイルとか作るんですかね？
0349デフォルトの名無しさん
2006/05/01(月) 20:58:42Doxygen とか関係なしに、コメント書きすぎなんじゃね？
もしくはコメント書かざるをえない設計とか？
0350デフォルトの名無しさん
2006/05/01(月) 22:23:54書きすぎってのはあるかも試練…
対象ユーザーのC++理解度が低い前提で書いてるんで
どう使ったらいいかのコード例みたいのもコメントに含んでるんだけど
やりすぎかね
@defgroup してモジュールの説明とか書き始めるともうコメントだらけですよ
0351デフォルトの名無しさん
2006/05/02(火) 16:26:030352デフォルトの名無しさん
2006/05/05(金) 14:12:41なんかうまい方法ある？
っつーかこんなん使うなって話になりそうな気もするけど
0353デフォルトの名無しさん
2006/05/06(土) 13:39:38プリプロセッサで消せば？
こんな感じで。
#ifndef __MSC_VER
#define __declspec(arg) /* ignore */
#endif
0354デフォルトの名無しさん
2006/05/11(木) 01:18:44http://www.doxygen.jp/
0355デフォルトの名無しさん
2006/06/11(日) 22:16:550356デフォルトの名無しさん
2006/06/14(水) 14:33:530357デフォルトの名無しさん
2006/06/22(木) 09:09:28まあ、すでに bugzilla に報告済みだから次のバージョンでは何らかの対策がされることを
期待するが。
0358デフォルトの名無しさん
2006/06/22(木) 10:13:30http://news19.2ch.net/test/read.cgi/newsplus/1150936122/l50
佐賀市は１９日、市税や住民票などを管理する市独自の基幹システムでプログラムエラーが
あり、国民健康保険税に課税ミスがあったと発表した。
この基幹システムは、旧市が韓国ＩＴ大手の「サムスンＳＤＳ」と約８億７千万円で共同開発し、
０５年４月から運用を始めた。開始直後は約５０人の同社員がエラーをチェックしていた。
市情報政策課は「昨年度もエラーはあったはずだが、データを手直ししただけで、プログラム
自体を修正しなかった可能性が高い」と話している。
0359デフォルトの名無しさん
2006/06/29(木) 23:09:030360デフォルトの名無しさん
2006/07/16(日) 19:06:32/// @file test.hpp
/// @brief doxygenテスト
/// 加算
int add(int a, int b);
/// 加算
加算double add(double a, double b);
をドキュメント化すると最初のint add(int a, int b)しか載りません。
クラスのメンバ関数はオーバーロードしたものもドキュメントに載るのに。
何か方法はないでしょうか？
0361デフォルトの名無しさん
2006/07/16(日) 19:15:50その 加算double ってのは何だ？
0362デフォルトの名無しさん
2006/07/16(日) 19:23:54/// @file test.hpp
/// @brief doxygenテスト
/// 加算
int add(int a, int b);
/// 加算
double add(double a, double b);
0363デフォルトの名無しさん
2006/07/24(月) 11:03:53簡単な書式のヘルプ作成ツールみたいなのないですか？
例えば.batなら
@echo off && goto enddoc
<title>mytool</title>
<description>なんか役に立つツール</description>
<parameters>
-h: このヘルプを表示
-v: verbose
</parameters>
:enddoc
...
メインの処理
とかやっといてフィルタかますとmytool.htmが生成されるとかそんな感じのもの
0364デフォルトの名無しさん
2006/07/24(月) 18:39:30その程度だったら、
自分でRubyかPerlあたりでフィルタ作ればいいんじゃない？
上の例を借りると、
@echo off && goto enddoc
REM @XX_BRIEF <title>mytool</title>
REM @XX_BRIEF <description>なんか役に立つツール</description>
REM @XX_BRIEF <parameters>
REM @XX_BRIEF -h: このヘルプを表示
REM @XX_BRIEF -v: verbose
REM @XX_BRIEF </parameters>
:enddoc
とでもしておいて、
行中に@XX_BRIEF等の特定のキーワードが含まれるかチェック
→ キーワードの後ろから行末までの文字列を抽出
→ 必要に応じて文字列を整形し、特定のフォーマットに変換
→ ファイルに出力
という感じで。
ソースコード内の変数名やメソッド名を参照するようなことはできないけどね。
0365デフォルトの名無しさん
2006/07/26(水) 04:08:381.4.7 で問題なく出力できた。
0366デフォルトの名無しさん
2006/07/28(金) 01:57:060367デフォルトの名無しさん
2006/10/18(水) 11:22:210368デフォルトの名無しさん
2006/10/30(月) 01:23:57> Generating caller graph for function foo
という行で止まってしまいます。
いつも同じ関数の処理をしている時に止まるようです。
止まってしまう関数の処理を中断して先に進ませる方法はないでしょうか？
0369デフォルトの名無しさん
2006/10/30(月) 11:19:270370デフォルトの名無しさん
2006/10/31(火) 00:35:52せっかく綺麗に作ったコメントがぐちゃぐちゃになるんだけど
なにか対策ある？
0371デフォルトの名無しさん
2006/10/31(火) 00:43:23<pre></pre> でどう？
場合によっては何かもっと適切な対策があるかもしれないけど。
0372デフォルトの名無しさん
2006/11/01(水) 00:55:01漏れはもう改行を気にするのはやめたけど。
0373デフォルトの名無しさん
2006/11/01(水) 13:48:26doxygenの整形に任せるのが正解。
改行が必要なほど複雑な説明を長々とコメントに書いてはいけない。
補足説明とか引数別の説明とか例外のリストとかそういうのは
それようのタグがあるのでそれを使ってdoxygenに整形させる。
0374デフォルトの名無しさん
2006/11/11(土) 11:36:25おまいら今なら作れば売れるぞw
0375デフォルトの名無しさん
2006/11/11(土) 12:00:06発明されない限り、ドキュメント作成ツールのメガヒットはありえない。
0376デフォルトの名無しさん
2006/11/11(土) 13:26:33おっぱいとか満載になっちゃって大変そう。
雑念払う練習しないと。
0377デフォルトの名無しさん
2007/01/08(月) 23:42:18ちょっと不思議な動きしてるんですけど、
ソースのバグなんだか、仕様なんだか、わからないよ！
と、１０年以上前に誰かが作ったソースをメンテさせられることになって
鬱状態の僕は思いました。５万行もあるよ。。
みんな、doxygen使ってるか！
ちゃんと、その関数が何やりたいのとかきちんと書いてな！
あとsunのJavadocみたいに、スレッドセーフかどうかとかも書いてあるとうれしいよ！
パッケージとかモジュールとか、ソースより大きい単位でも
doxygenってドキュメント書けるの？
>>374
買うから作って。
あけましておめでとう。
0378デフォルトの名無しさん
2007/03/10(土) 16:46:51"要件定義"
同じものを違う呼び方してるだけ？
0379デフォルトの名無しさん
2007/03/10(土) 17:25:20レイヤーが違う
上位が要件、下位が要求
0380デフォルトの名無しさん
2007/03/10(土) 17:53:37これらを区別していない書籍も多いと思ったのですが、
そんなことないでしょうか？
0381デフォルトの名無しさん
2007/03/10(土) 17:55:280382デフォルトの名無しさん
2007/03/10(土) 18:40:21それぞれ英語では何という語句にあたりますか？
0383デフォルトの名無しさん
2007/03/10(土) 20:30:09要件はマターとかファクター
要求はリクエスト
0384デフォルトの名無しさん
2007/03/10(土) 20:52:380385デフォルトの名無しさん
2007/03/10(土) 21:02:38requestもrequireも語源は同じですよ
re(再び) ＋ quaerere(ラテン語で求める)
再び求める ⇒ 要求、お願い
requireよりrequestの方が若干丁寧です
0386デフォルトの名無しさん
2007/03/10(土) 21:49:15海外では"requirements definition"。
日本の計算機屋の言語感覚が鈍かったから、「要求」と「要件」がごっちゃになってる。
「要求」の方だけ覚えときな。
0387デフォルトの名無しさん
2007/03/10(土) 23:01:13"要件"・・企業で使われる
だろ？
0388デフォルトの名無しさん
2007/03/10(土) 23:27:230389デフォルトの名無しさん
2007/03/12(月) 01:50:03レイヤーが違うというなら、
比喩的に、ボールペンの
要求定義、要件定義はどのようになるんでしょうか。
0390デフォルトの名無しさん
2007/03/12(月) 21:24:59[要求]
先端は鋼などの硬球
運筆に応じて回転、軸内のインクが滲出
0391デフォルトの名無しさん
2007/03/12(月) 22:01:440392こんなもんかな
2007/03/13(火) 10:29:20速記に適し、それなりの耐久性を有すること。
ある程度の耐候性があればインクの種類は問わないが、掠れ難いこと。
0393デフォルトの名無しさん
2007/03/13(火) 10:52:47字が書けること
0394デフォルトの名無しさん
2007/03/13(火) 23:51:25そっちのが要求じゃないの
あっこれマジレスってやつかっ？
0395デフォルトの名無しさん
2007/03/14(水) 00:16:560396デフォルトの名無しさん
2007/03/14(水) 00:48:48- 普通紙に字が書けること
- インクの補充が容易であること
- 出来うる限りメンテナンスフリーであること
以上の要求を実現する筆記用具を開発することにより、ユーザーの利便性を高め
生産性の向上に（以下省略
＞以上の要求を実現する筆記用具を開発することにより、ユーザーの利便性を高め
＞生産性の向上に（以下省略
↑この辺が要件。
0397デフォルトの名無しさん
2007/03/14(水) 01:06:54少なくとも日本IBMでは区別してるようだな。
IEEEでは単にSoftware/System Requirements Speciticationであって、
区別してないようだな。
0398デフォルトの名無しさん
2007/03/14(水) 01:19:00上の例で挙げられているような仕様書は、
今どきコボラーくらいしか書かないんじゃないかな。
0399デフォルトの名無しさん
2007/03/14(水) 04:30:05要望は客が単に思ってること
要求はシステム上不可欠なこと
要件は実装するシステム機能
ま、いちいち分類したところで、結局ドキュメントを書かないもれには関係ない話だｗ
0400デフォルトの名無しさん
2007/03/15(木) 00:34:54その意味じゃ>>396の言ってる事がしっくりくるｗ
0401デフォルトの名無しさん
2007/03/15(木) 17:05:37ってこと？
0402デフォルトの名無しさん
2007/03/18(日) 15:15:13システム全体を見据え、ドキュメントを体系化すべし。
富士通だと、SDAS
ttp://img.jp.fujitsu.com/downloads/jp/jmag/vol57-1/paper01.pdf
NEC、日立も似たようなもん持ってる。（どれが良いとかはシラン）
孫会社、下請けは知らないかもしれないが、本尊の動きくらい知っときなょ。
0403デフォルトの名無しさん
2007/03/18(日) 21:26:20マニュアル → 専門のテクニカルライターを使う
設計書 → システム全体が見渡せるもの／外部仕様はしっかり書く。
内部仕様はほどほど。（結局ソースが正になるから）
ドキュメントが無いソフトは糞とかいうけど、
ドキュメントが無いと保守できないソフトこそ糞だと思う今日この頃だよ。
0404デフォルトの名無しさん
2007/03/18(日) 23:12:23一口にドキュメントの是非を問うから議論が分かれる気が。
>>403 が言うとおり、
システム全体像・外部仕様はしっかり、
内部仕様はソースが正、doxygen とかで自動生成
って言えば、あんまり反対する人いないと思うんだけど。
0405デフォルトの名無しさん
2007/03/18(日) 23:15:45開発用と別に書いて渡してますか？
0406デフォルトの名無しさん
2007/03/19(月) 00:49:55内部仕様書でも、分業単位の分まではきっしり作っておこう
0407デフォルトの名無しさん
2007/03/19(月) 04:40:13上場企業だと、内部統制の関係で全てキッチリ必要
0408デフォルトの名無しさん
2007/03/27(火) 23:59:41CVSに入ってるdoxygenだとCPP_CLI_SUPPORTという設定が使えるみたいなんだけど
0409デフォルトの名無しさん
2007/03/28(水) 09:19:09上場企業というより、メーカー系の企業だな。
やつらは工場で作るものとソフトウェアを同じ体系にまとめようとするからムリがある。
上場企業でもソフトハウス系はそんなことない。
0410デフォルトの名無しさん
2007/03/28(水) 12:50:41でも、工場で作るものと同じ仕様で仕様書を作っておくと
何年後でも開発者が死んだあとでもメンテが出来たりするので
あなどれないんだよな
0411デフォルトの名無しさん
2007/03/28(水) 18:55:580412デフォルトの名無しさん
2007/03/29(木) 09:16:07それ以上細かい内部仕様書は糞。
思うに、本当の内部仕様書ってのはソースコード自身だと思う。
0413デフォルトの名無しさん
2007/03/29(木) 11:35:18それじゃ バグがあっても仕様通り ぢゃあないか
0414デフォルトの名無しさん
2007/03/29(木) 11:50:55一番役立つのがソースコードとソース内にきちんと書かれたコメントなんだよね。
尤も、それらがきちんと書かれていないコードに限って後から不具合が露見するんだが。
で、ついでに言えばそういうプロジェクトは大抵仕様書に仕様変更がきちんと反映されていないから仕様書は手掛かりにしからない罠。
0415デフォルトの名無しさん
2007/03/29(木) 12:14:21979 名前： デフォルトの名無しさん [sage] 投稿日： 2007/03/29(木) 10:14:13
処理Aの仕様書
・・・Aを実行する。
１行きたー。どうしよう。
0416デフォルトの名無しさん
2007/03/29(木) 23:41:270417デフォルトの名無しさん
2007/04/05(木) 13:28:09UTF-8 ｷﾀ
0418デフォルトの名無しさん
2007/04/14(土) 22:07:50書籍でも良いです
0419デフォルトの名無しさん
2007/04/14(土) 22:33:19実務資料はふつープロジェクト外秘や社外秘だから
必要なら会社で見せてもらえ
0420デフォルトの名無しさん
2007/04/14(土) 22:35:59見覚えあるプロジェクトの公開資料が出てきてびっくらこいたｗ
0421デフォルトの名無しさん
2007/05/16(水) 01:23:38多そうでしたので質問させてください。
WinXPProSP1 VB6.0で開発を行っており、
このVBのソースをdoxygenに出力させたいのですが、
どなたか方法をご存知の方はいらっしゃらないでしょうか?
ネットを漁りvbfilterを使用し、tee.exe/gawk.exe/sh.exeも必要との事でインストールし、
input-filterに 「C:\vbfiltervbfilter.bat C:vbfilter\tools」と入力し
なんとか変数一覧やメソッド一覧等が出力されるようになったのですが、
コメント部分の文字が化けてしまいます。
VBのソースがshift-jisで書かれておりdoxygenのinput-encodingが
UTF-8になっておりましたので、nfk.exeもインストールしdoxygenのinput-filterに
「C:\vbfiltervbfilter.bat C:vbfilter\tools|"nfk -w"」
としてみたのですがうまく変換されません。
(nfk単体で確認した所うまくshift-jis→utf-8変換処理は動作しておりました。)
恐らくdoxygenのinput-filter辺りでうまくパイプ処理が使えていないのが
原因だと思います。
４～５時間ほど試してみたのですが自分の力では解決できず
書き込みに至った次第です。
説明不足も多々有ると思いますがどなたか
方法をご存知の方がいらっしゃいましたらご教授のほどよろしくお願い致します。
0422デフォルトの名無しさん
2007/05/16(水) 06:57:14ソースが shift-jis だってんなら INPUT_ENCODING=Shift_JIS だろ。
0423デフォルトの名無しさん
2007/05/16(水) 10:48:18で、input_filter="iconv -f eucjp -t cp932"、use_windows_encodig=yes、output_language=japaneseで使ってるが。
#doxygenはcygwinので、バージョンは1.5.1。
0424デフォルトの名無しさん
2007/05/16(水) 11:15:06VB 使いが言う shif-jis は cp932 が正解だろうな。
0426423
2007/05/16(水) 11:50:37#RedHatNetworkは1.3.9.1のままだし。
今回(1.5.2)の変更点はUTF-8対応のほか、C++/CLI対応だとか随分Win使い寄りのような。
件のinput_encodigやdoxyfile_encodingが追加されたと同時にuse_windows_encodingが無くなったようなので、
私のところでは進行中のプロジェクトのDoxyfileをいくつか修正する必要がありそうです。
#逆に、rtfとtexのencodingをわざわざ変えなくて済むようになるなら嬉しいけれど。
0427デフォルトの名無しさん
2007/05/16(水) 23:22:190428421
2007/05/17(木) 02:03:27>>422様の仰るとおり
INPUT_ENCODING=Shift_JIS
input-encoding=C:\vbfiltervbfilter.bat C:vbfilter\tools
にして見た所VBのソースが文字化けせず正常に出力される事が確認できました。
ありがとうございました。
と言うかこんな事に気付かない俺ってダメすぎですorz
的確な突っ込みありがとうございました。
0429デフォルトの名無しさん
2007/05/17(木) 10:27:210430デフォルトの名無しさん
2007/06/21(木) 11:08:45コメントを書いてきたんだけど、やっぱりそれじゃ
後から見てばらばらで気持ち悪いので、何らかの
ドキュメント自動生成ツールに従った形で書こうと思っています。
doxygen / javadoc / phpdocumentor などのツールが
あるようですが、書式はそれぞれ異なるんですよね？
スレタイに doxygen / javadoc / phpdocumentor とかの文字列が
なかったから検索に手間取っちゃったよ・・・
0431デフォルトの名無しさん
2007/06/25(月) 10:46:20#phpのは知らない。
0432デフォルトの名無しさん
2007/06/25(月) 12:22:53その3つなら、PHPとJava使うときはそれぞれの、他はDoxygenでいいんじゃね。
0433デフォルトの名無しさん
2007/06/25(月) 20:30:050434デフォルトの名無しさん
2007/07/06(金) 01:22:50Windowsヘルプを 作成しているのですが、索引が
どうしても文字化けしてしまいます。
INPUT_ENCODING = Shift-JIS
DOXYFILE_ENCODING =UTF-8
と設定し、ページに関しては文字化けは解消された
のですが… 何か解決策があれば教えてください
0435デフォルトの名無しさん
2007/07/28(土) 08:38:520436デフォルトの名無しさん
2007/08/12(日) 01:05:32doxygen ではよくこの書き方が紹介されているが、個人的にあまりおすすめしない。
/*!
@brief メソッドの説明
@param p 引数の説明
@return 戻り値の説明
*/
・複数行コメントは一括コメントアウトの邪魔になるから
・実コードで引数が変更になると Doxygen の内容も変更しなくちゃいけなくなるから
（つまりコードと Doxygen の２重管理になる）
0437436
2007/08/12(日) 01:08:05//! @brief メソッドの説明
//! @return 戻り値の説明
void hoge(
p //!< p の説明
)
{ ... }
0438デフォルトの名無しさん
2007/08/12(日) 01:46:25>437のやり方だってコードとコメント両方メンテすんのはかわらん。多少近くなるが。
あと長い説明を入れにくくなるな。
0440439
2007/08/12(日) 01:56:360441デフォルトの名無しさん
2007/08/12(日) 02:30:53おまえら、ドキュメントなんて書きたくなきゃ書かんでいいぞ。
例えばWindowsにはヘルプがあるだろう。
けど、WindowsのGUIは洗練されてるから、あんなの読まなくても判るよな。
判らん奴もいるが、どうせそいつらはヘルプの読み方すら判らんアホだし、
付き合うだけ無駄だろう、と。こういった無茶な主張も今や世間が味方だ。
つまりウィンドウの操作なんて、もはや一般常識なのだ。凄い時代になった。
この概念を突き進めていけば、ユーザーはプログラムの画面を見れば、
何をすべきなのか判るという事だ。洗練されたGUIによって、プログラムと、
ドキュメントは融合を果たしたわけだ。
画面見て使い方が判らないプログラムはゴミと同じ。(これはGNU製に多い)
いや、むしろ今の時代は判らないとのたまう人間の方が、立場は下なのだ。
「ドキュメント見なくても判ります」
おまえら、この言葉を吐く自信はあるか？
0442デフォルトの名無しさん
2007/08/12(日) 02:56:38GNU の作った GUI 製品って、何かあったっけ？
0443デフォルトの名無しさん
2007/08/12(日) 04:59:50> WindowsのGUIは洗練されてるから
笑うところですか？
0444デフォルトの名無しさん
2007/08/12(日) 05:11:080445デフォルトの名無しさん
2007/08/12(日) 13:51:49void hoge( //! @return 戻り値の説明
ついでにここまでやろう
0446デフォルトの名無しさん
2007/08/12(日) 13:53:32どこ立て読み？
0447デフォルトの名無しさん
2007/08/12(日) 16:57:19ＧＴＫ＋
0448デフォルトの名無しさん
2007/08/12(日) 17:46:54それは GUI 製品とは言わんだろ。
画面見ただけで GTK+ の使い方がわかったら神だな。
0449デフォルトの名無しさん
2007/08/12(日) 21:34:45Sylpheed
0450デフォルトの名無しさん
2007/08/12(日) 22:09:55そいつらは GPL でライセンスされてるだけで GNU 製とは言わんのじゃないか？
もしかして >>1 や >>441 の言ってる GNU 製ってのは GPL でライセンスされてる
製品ってこと？それなら作者もバラバラなはずだから、ただの偏見だね。
0451デフォルトの名無しさん
2007/08/12(日) 22:44:33見ただけで処理がわかるとか
どんだけ紙プログラマなのｗ
ユーザがそんなに凄けりゃ俺たち要らない子だよね（・ω・
0452デフォルトの名無しさん
2007/08/12(日) 22:49:21あれはフォトショのコピーUIな気もするが。
0453デフォルトの名無しさん
2007/08/12(日) 23:10:29今更Cでオブジェクト指向ゴッコかよ
と思わないでもない
0454デフォルトの名無しさん
2007/08/12(日) 23:44:15使う人間の方にしわ寄せがくる。DLLにしたくてもABIの問題もあるし。
COMやQTは難解すぎる。
C++はプログラマのフロントエンドとしてのみ使うべきだろう。
0455デフォルトの名無しさん
2007/08/12(日) 23:49:25失敗すると勝手にexitやabortするアホなのがあった。
勝手に終わらすなや。straceなかったら死んでた。
0456デフォルトの名無しさん
2007/08/13(月) 01:11:070457デフォルトの名無しさん
2007/08/13(月) 12:02:32>>436
＞・複数行コメントは一括コメントアウトの邪魔になるから
一括コメントアウトってなに?
ソース管理の原則からは、不使用コードは#ifで囲ってしまうべきであり/* */や//は使うべきではない。
まして、基本的にリリース時には残さないべきなので、複数行コメントを忌避する理由はないと思う。
0458デフォルトの名無しさん
2007/08/13(月) 22:07:06でも実際に集中して作業してるときって /* */ 使わないか？
#if #endif より入力しやすいと思うんだが。
ついでに、古いコーディング規約が改定されずに使われる場合、
「VSS でチェックインするソースには原則として /**/ を含まないこと」
みたいな決まりが未だにまかり通る現場もあるんでは？（←ウチだけか？）
>> // は使うべきではない。
おまえんとこは１行コメントも #if なの？
0459デフォルトの名無しさん
2007/08/13(月) 22:11:15/**/を使ってはならないという規則で/**/でコメントアウトするのは
ナンセンスな気がするが……
もっと言うと、/**/でコメントアウトするときに障害になるから
/**/を使うなということか
あまりにナンセンスすぎて意味がよくわからないな
0460デフォルトの名無しさん
2007/08/13(月) 22:24:42こんな些細なネタで話を伸ばしたくないんだが。
/**/ は作業中のみ一時的な目的に使うべし、
チームメンバーに公開するソースからは /**/ 無くすべし、
当然使わないコードは消すべし、
一時的に残すなら #if ～ #endif を使うべし。
ということでまぁ折り合いがついてる。
それより、
>> // は使うべきではない。
> おまえんとこは１行コメントも #if なの？
についての解答が欲しい。あんまりコメント書かない習慣ってことか？
0461459
2007/08/13(月) 22:34:47俺は上の人とは違う（はじめて書き込んだ）ので、上での話を
俺に聞かれても知らん。
俺のことを言えば、//を禁じるのも/**/を禁じるのもナンセンスにしか
思えない。
0462デフォルトの名無しさん
2007/08/13(月) 22:42:06人違いスマソ
大人しく 457 からの回答を待つよ
0463デフォルトの名無しさん
2007/08/14(火) 00:37:35//f(a, // aのコメント
//b, // bのコメント
//c) {// cのコメント
//}
/*
f(a, // aのコメント
b, // bのコメント
c) {// cのコメント
}
*/
↑つまりこんなことするなって？（こんなことするか？）
#if 0
f(a,b,c) {
}
#endif
>>458
/* */て右手だけでシフト押したりするから入力しづらくね？
手前のキー使うから爪切ってないと辛い
#if 0
#endifのが気持ち早い
0464458
2007/08/14(火) 00:58:23が紹介したような使い方は稀だけど、無効化した理由を添えることはあるだろう。
// int i = func();
int i = func2();
// ↑×××により○○○に変更。
/* */ の入力にシフトは使わん。テンキーについてるやつを使う。
0465デフォルトの名無しさん
2007/08/14(火) 02:00:540466458
2007/08/14(火) 10:24:320467457
2007/08/14(火) 11:04:13読み難かったかな。
不使用コードをコメントアウトする目的で、/* */や//は使うべきではないということね。
その目的で//を使うと、例えばリリース前に消したくても通常のコメントと区別がつきにくいので消し損ねかねない。
#ifならgrepでの検出も簡単だろう。
って、>465が書いているね。更には、リビジョン管理しているなら残すべき理由もないはずだが。
0468デフォルトの名無しさん
2007/08/14(火) 22:41:53/*
c = d;
*/
e = f;
↑こうなってるときに
/*
a = b;
/*
c = d;
*/
e = f;
*/
↑あとからこんなことする馬鹿がいるからじゃね？
0469デフォルトの名無しさん
2007/08/15(水) 03:51:34誰に向けて書いたのか知らないがそれはコンパイルエラーだから論外
0470デフォルトの名無しさん
2007/08/18(土) 03:26:180471デフォルトの名無しさん
2007/08/22(水) 00:13:17それが使われているコードなのかコメント化されているコードなのかがgrepの結果からだけでは分からない。
てなわけでうちでは // だけ使うことになってる。
0472デフォルトの名無しさん
2007/08/22(水) 11:30:55だからこそ、リリース版のソースにコメントアウトされたコードを残してはいけないのです。
0473デフォルトの名無しさん
2007/08/23(木) 01:19:20規則で定められてるんだけど、もしかしてレア？
0474デフォルトの名無しさん
2007/08/23(木) 01:22:000475デフォルトの名無しさん
2007/08/23(木) 01:50:24いや。よくある糞規則。
0476デフォルトの名無しさん
2007/08/23(木) 05:59:570477デフォルトの名無しさん
2007/08/24(金) 01:10:240478デフォルトの名無しさん
2007/08/24(金) 10:56:270479デフォルトの名無しさん
2007/08/24(金) 11:33:090480デフォルトの名無しさん
2007/08/24(金) 11:46:27Cでも未だあるらしいよ。
0481デフォルトの名無しさん
2007/08/24(金) 22:18:510482デフォルトの名無しさん
2007/08/24(金) 22:45:510483デフォルトの名無しさん
2007/08/25(土) 14:35:46元のがループ使わずコピペでシコシコ行数稼いでいるプログラムがあった
マジで
0484デフォルトの名無しさん
2007/09/03(月) 22:19:04F痛
0485デフォルトの名無しさん
2007/09/04(火) 07:28:560486デフォルトの名無しさん
2007/10/27(土) 18:26:590487デフォルトの名無しさん
2007/10/28(日) 13:23:14たしかに、excelで、罫線使いまくったドキュメントって書くのが面倒なんだけど、
かといって、日本式のそういうドキュメントしか見たことないから、罫線なしで
かっこいいドキュメントというのが想像できません。
外国で使われてるドキュメントのサンプルみたいのを見れるところってありませんかね。
0488デフォルトの名無しさん
2007/10/28(日) 20:18:16米のミドルウェアをいくつも使ったけど、そのへんのオープンソースのよりもショボい感じ。
オープンソースのをいくつも見ればいいと思うよ。
0489デフォルトの名無しさん
2007/10/29(月) 01:30:01表示ソフトいらないし、ファイル1個で済むし
*NIXで見れない？
知 る か
0490デフォルトの名無しさん
2007/10/29(月) 02:08:39つttp://xchm.sourceforge.net/
0491デフォルトの名無しさん
2007/10/29(月) 12:29:28罫線を使わないこととExcelを使わないことはイコールではないよ。
喩えて言えば、○×をやるのに周りを囲むか(囲こんな形)か、囲まないか(井こんな形)の違い。
0492デフォルトの名無しさん
2007/12/08(土) 03:09:44todoリストみたいにまとめたいなと思って調べたら、
\xrefitemを使えばオリジナルの\todoができることは、わかったのですが、
関連ページ追加される項目を日付ごとにまとめて並べること方法ないでしょうか?
0493492
2007/12/10(月) 02:14:40ALIASES += "history{1}=\xrefitem histories\1 \"更新履歴(\1)\" \"更新履歴(\1)\""
日付でソートできていないし、日付ごとに別ファイルになってしまいます。orz
もっとよい方法は無いでしょうか?
0494デフォルトの名無しさん
2007/12/30(日) 02:14:53・機能ごとに、仕様書があったりなかったり
・管理がずさんで、どのファイルが本物の仕様書かわからなかったり
・仕様書が現状の実装と同期がとれてなさそうだったり
てな具合。
で、どうにかせにゃアカンってことで、取り急ぎコード修正・保守作業に
最低限必要なドキュメントだけ、リバースエンジニアリングして書き起こしてる
とこなんだが、作った後の維持管理って、みんなどんな感じでやってる？
0495デフォルトの名無しさん
2007/12/30(日) 11:15:070496デフォルトの名無しさん
2007/12/30(日) 17:27:360497デフォルトの名無しさん
2008/01/02(水) 20:27:53市役所ネイティブの部署と、運用を委託されてる会社の人が常駐している実務
部隊の２通り取り方があるわけだがどっち？
0498デフォルトの名無しさん
2008/01/09(水) 12:59:45出力ファイルのエンコード指定ができるようになっているのはいいんだ
けど、言語とエンコードの指定に関係なく生成されたHTMLのヘッダ部分
は、「charset=UTF-8"」なんだが、ガイシュツ？
ブラウザ側のエンコード自動識別のおかげでHTMLドキュメントはうまく
表示できるが、HTML Help CompilerでHTML Helpファイルに変換すると、
インデックス部分の日本語が化ける。
0499デフォルトの名無しさん
2008/01/09(水) 16:53:47hhc.exe index.hhpでおｋ
0500498
2008/01/09(水) 19:45:11それじゃあ、ツールを使って自動化する意味ないじゃん。
他にも、index.hhpでのフォント指定やら変で、特に1.5.x以降を使う
メリットが見当たらないので、結局1.4.7に戻した。1.4.7は、Japanese
選択しとくと、「charset="SHIFT_JIS"」になる。
HTML Help をコンパイルする前にフォントを変更しても、Doxygenで生成
されるソースコードのページのフォントが変なんだよね。どうもアルファ
ベット部分だけ、無条件にArialになってるっぽい。
0501499
2008/01/10(木) 02:54:40ツール側の対応に頼るのもいいけどさ。
0502デフォルトの名無しさん
2008/01/10(木) 06:10:22作成するよう指示がありました。
ちなみに開発環境はTurboC++。
C++の知識レベルは、入門書１冊読んだ程度。（アプリ開発経験なし）
Doxygen使ってみたのですが、Doxygen対応コメントで作成されてないので
クラス階層とか関数呼出などの図ではイメージできるのですが、
コメントがないので、やってることがさっぱりわかりません。
そういう場合は、やはり、ソース解読しながら、
Doxygen対応コメントをひたすら打ち込むことから始めるべき
なのでしょうか？
0503デフォルトの名無しさん
2008/01/10(木) 07:58:380504デフォルトの名無しさん
2008/01/11(金) 14:48:40でも、そこで要求されている「アプリのドキュメント」はDoxygenの出力でいいの?
通常はその括りだと基本仕様か機能仕様に類する資料が必要になってくると思うのだけど。
0505デフォルトの名無しさん
2008/02/10(日) 21:43:340506デフォルトの名無しさん
2008/02/11(月) 11:45:180507デフォルトの名無しさん
2008/02/11(月) 12:09:51ここはDoxygenスレじゃないんだぜ
0508デフォルトの名無しさん
2008/02/12(火) 14:02:50このスレもそのスレも今まで以上に過疎るからやめてほしいぜ
0509デフォルトの名無しさん
2008/02/12(火) 14:42:190510デフォルトの名無しさん
2008/02/12(火) 14:47:100511デフォルトの名無しさん
2008/02/12(火) 15:06:37噛み付く奴って何なの？
0512デフォルトの名無しさん
2008/02/12(火) 15:33:25「1ヶ月ぶりのレスだから何書いても許す」というほうが不条理
0513デフォルトの名無しさん
2008/02/12(火) 15:35:41敢えて>509の言うように「個々のツールの使い方」は無関係だとしても、「個々のツールの情報」は無関係じゃないだろ。
0514デフォルトの名無しさん
2008/02/12(火) 15:46:47何書いても許すなんて言ってないだろ、ボケ
「お前の意に沿わないレス」で噛み付くなって言ってんだ
0515デフォルトの名無しさん
2008/02/12(火) 16:05:15噛み付くなともいへり。
0516デフォルトの名無しさん
2008/02/12(火) 16:06:100517デフォルトの名無しさん
2008/02/12(火) 16:15:09いいですか、↑これがどうしようもないレスという物の見本です
0518デフォルトの名無しさん
2008/02/12(火) 16:17:58↑これはどうかな。優等生過ぎてどうしようもない？
0519デフォルトの名無しさん
2008/02/12(火) 22:50:57そもそも何を書いていいのか分からんのだよ
0520デフォルトの名無しさん
2008/02/12(火) 23:44:47大丈夫だ。どうせ誰も見ない。
ぐらいの気持ちで書いてまつ。
本当に皆が必要な内容ならそんな悩まなくても書けるよ。
0521デフォルトの名無しさん
2008/02/13(水) 01:27:10「ドキュメントは読みましたか？ﾌﾌﾝ」とするために書く。
0522デフォルトの名無しさん
2008/02/13(水) 23:08:46とりあえず日付を真っ先に書くようにしている。
ほかの文章は後からでも書けるけど、
こればっかりは後から思い出そうとしても思い出せない。
0523デフォルトの名無しさん
2008/02/15(金) 15:13:160524デフォルトの名無しさん
2008/02/16(土) 12:59:06ついでに天気とその日の主な事件も書いとけ
0525デフォルトの名無しさん
2008/02/26(火) 20:56:32書いたら怒られたんだが, なぜ?
0526デフォルトの名無しさん
2008/02/26(火) 23:47:14理由も聞かなかったのか？馬鹿
0527デフォルトの名無しさん
2008/02/27(水) 00:17:200528デフォルトの名無しさん
2008/02/27(水) 00:26:100529デフォルトの名無しさん
2008/02/27(水) 00:26:460530デフォルトの名無しさん
2008/02/27(水) 15:40:49俺も重複を避ける為にそう思った。
が、この文法では、@param属性(入力,出力、入出力)が付けられない。これは痛い。
従って、@paramを使わざるをえなかった。
//445
ダメだよ、それじゃ。パッと見でもおかしいし、実際 変な表示になるよ。
0531デフォルトの名無しさん
2008/03/05(水) 23:50:08俺はExcel派。
Word使うヤツの気が知れない。
要するに、あとで文章直すときに改行がExcelだと
大変だってだけの話でしょ？
レイアウトは断然Excel優位だよね。
0532デフォルトの名無しさん
2008/03/05(水) 23:52:510533デフォルトの名無しさん
2008/03/06(木) 09:04:30でもスタイル指定しないWordはひょっとしたら
確かにExcelよりクソかもしれない。
0534デフォルトの名無しさん
2008/03/06(木) 16:21:430535デフォルトの名無しさん
2008/03/07(金) 01:26:50> マニュアル・手順書
にかぎるんだったら, エディタで書いた平テキスト
エンドユーザー向けのマニュアルは別部門が作る
図面ほしいって言われたら、CAD 図面
# 新規ハード使う組み込み系の仕事がほとんどだが
0536デフォルトの名無しさん
2008/03/12(水) 18:34:18関数仕様書を作るのにdoxygenを使おうとしています。 ver1.5.5を使っている
のですが、HTML出力は上手くいくものの、rtf出力になるとUTF-8でエンコード
されていて、テキストエディタでは日本語が読めるのですが、Wordやワードパッド
では文字化けして読めません。これではRTF出力する意味がありません。
DoxyWizardでは出力、入力ともShift-JISに設定しているのですが・・・(当然、
ソースのコメントはShift-JISです)
一体何がいけないのでしょうか？
0537デフォルトの名無しさん
2008/03/12(水) 21:54:59↓
SHIFT_JIS
0538536
2008/03/13(木) 09:27:00「gnuのlibiconv使ってるからそこのページ見ろや」みたいな表示が出るので
そこを見てコピペしたからだと思います。
HTMLはちゃんと表示出来るのにRTFがダメなのが良く分かりません。
0539デフォルトの名無しさん
2008/03/13(木) 13:50:290540536
2008/03/14(金) 18:08:47どうも、エンコード方式を指定するバージョンでは全てダメのようで。
具体的には1.5.2からはダメ。
仕方ないので1.5.1以前を使おうかと思います。ソースいじってなんとかする
スキルはないし。
あと、ついでにもう気づいた事。@paramコマンドで[in][out]表示が出来ますが、
HTMLでは問題ないものの、RTFでは何故か表示できません。
なぜRTFにこだわるかと言うと、提出物としてはHTMLよりもWord文書の方が良い
のではないかという事です。RTFならそのままwordで読めるし、DOCに直すにしても
ほとんど手直しの必要がないですからね。
まぁ、Word出力するなら商用ツール使えって事なのかなぁ・・・でも、ウチの会社
そんなに余裕ないし。
0541デフォルトの名無しさん
2008/03/14(金) 20:30:260542デフォルトの名無しさん
2008/03/24(月) 11:25:04うちじゃどうしても日本語が必要なときはTeXで出して、pdfに落として提出した。
そうでないときは、全部英語にしておいた。
そうか、1.5.1ならRTFに日本語を出せたのか……
0543デフォルトの名無しさん
2008/04/07(月) 23:38:23たとえば
int f(int x)
{
…
}
というソースがあったら
/*!
*
* @param x
* @return
*/
int func(int x)
{
…
}
のような感じでコメントを挿入してくれるとありがたいです。
0544デフォルトの名無しさん
2008/04/12(土) 21:56:16よし、売ろう
0545デフォルトの名無しさん
2008/04/13(日) 16:41:20Visual Studioでの開発ならマクロ組めば出来るんじゃないかな
0546デフォルトの名無しさん
2008/04/28(月) 19:31:50「意味がわからん！！！ 書き直してこい！！！」
と言われてしまったんだが、おまえらどうやって説明してますか？
# 一応、説明文は遷移図一枚につき5ページくらいは書いたんだが…
0547デフォルトの名無しさん
2008/04/28(月) 19:34:27＞# 一応、説明文は遷移図一枚につき5ページくらいは書いたんだが…
説明文をだらだらと長く書きすぎたんじゃない？
0548デフォルトの名無しさん
2008/04/28(月) 19:42:13これじゃわからんって言うから、書き足していったらこうなった
どう説明すりゃいいんだ？
縦線ひいて斜め矢印か？
例外だらけになるやないか！！！
0549デフォルトの名無しさん
2008/04/28(月) 19:46:17怒られたのに何がダメだったのか聞いてはないの？
0550デフォルトの名無しさん
2008/04/28(月) 19:50:19箇条書きにした？
0551デフォルトの名無しさん
2008/04/28(月) 19:51:26もっと詳しく書けっていったから詳しく書いたんだが、ついでに数式まで交えて…
「例をだせや！！！」っても、「はじめてなんでありません」と…
0552デフォルトの名無しさん
2008/04/28(月) 19:52:27そういえば、VSってソース解析する上にマクロからアクセスできるんだったな。
ドキュメント自動生成マクロなんかあってもよさそうなのにな。
何とか工房がそうなのか？
0553デフォルトの名無しさん
2008/04/28(月) 20:10:39相手が理解できない点を、推測じゃなくて、ちゃんとヒアリングするのは無理なのか?
あと、説明するときは、いきなり本物じゃなくて、ミニマムセットで理解できるかどうか確認するとか。
そこらへんにギャップがあると、「それじゃわからん」vs「ではどう書けと」の対決になるような希ガス。
0554デフォルトの名無しさん
2008/04/28(月) 21:32:33必要なんじゃない？
0555デフォルトの名無しさん
2008/04/28(月) 22:06:01こうかｗ
0556デフォルトの名無しさん
2008/04/28(月) 23:24:10状態遷移図と突き合わせできるように書けばOK
0557デフォルトの名無しさん
2008/04/28(月) 23:33:37しかし、シーケンス図だと条件分岐がすごく書きにくくない?
0558デフォルトの名無しさん
2008/04/29(火) 01:20:360559デフォルトの名無しさん
2008/04/29(火) 01:28:420560デフォルトの名無しさん
2008/04/29(火) 12:28:52やりとりに出てくるもの全てを図に入れて，なおかつどんなやり取りが行われるのかを書かないといけないんでないかい？
でもヒアリング一発ですみそう
0561デフォルトの名無しさん
2008/04/29(火) 12:46:130562546
2008/04/29(火) 14:38:51RFC を参考にしてではなく RFC 提出できるくらいまじめに書いた
だけど、定義してるのはプロトコルなんで
「実装する奴が理解でない！！！」
結局, フローチャート書きまくりだとか数式無しだとかじゃないと
駄目らしい
だけどさ、状態遷移図をコーディングレベルに落すのは
「あんたらの仕事じゃねぇの？？？」 >>25才位のクライアントの担当者
# つか、ステートマシンとか習わかったのか？
0563デフォルトの名無しさん
2008/04/29(火) 14:57:59もしかして日本語がやばいんじゃないか？
0564546
2008/04/29(火) 15:12:04おぉ、そうかもしれん ＞俺の日本語 Www
だれどさ、院出てから、10年以上この業界に巣食ってるけど、
いままでお目にかかったことがない ＞こんなクライアント
0565デフォルトの名無しさん
2008/04/29(火) 15:23:280566546
2008/04/29(火) 15:44:01今まで、地方自治体外郭団体向けに事務処理ソフト作って{る|た}会社
>>564 書く直前に
「理工系の知り合いに聞いたら、うちが悪かった」
って，電話入ってきた。
まぁ、>>564 ただの愚痴だし、確に、俺も悪かった思うが………
こんなに、言語の差があるもんなのか？
0567デフォルトの名無しさん
2008/04/29(火) 16:41:310568デフォルトの名無しさん
2008/04/29(火) 16:46:09いつまでも自分流儀でやって、愚痴たれながしとけばいいよ。
0569デフォルトの名無しさん
2008/04/30(水) 00:07:17不思議はないが不甲斐ないな、そこ。
0570デフォルトの名無しさん
2008/04/30(水) 02:15:31VS2005ならDoxyCommentがいいんじゃね
書式もカスタマイズできるし
0571デフォルトの名無しさん
2008/04/30(水) 02:52:52ＤＢの構成とか設計書とか。
「読んだら分かる」っていつも言われるんだけど、
どうしたらいいかな。
0572デフォルトの名無しさん
2008/04/30(水) 03:18:04落ち着いてジックリ読んでみな。
0573デフォルトの名無しさん
2008/04/30(水) 10:43:42そう言う所は、得てして「うちはどこそこの仕事をしているんだ」って妙な自負があるから
こっちが何を書いてもクレームつけるよ。謝罪の電話があっただけでもましな方かも。
# うっかりしていると、同じドキュメントを「概要」と「詳細」と「解説」の3バージョン作る羽目になったり。
0574デフォルトの名無しさん
2008/04/30(水) 13:11:380575デフォルトの名無しさん
2008/05/01(木) 21:02:41ドキュメントは読めるようになったほうがいいよ。人に
頼ることなく進む力がぐんと増える。(ドキュメントに
頼る時点で、というのは無しで)
どうしたらいいかと言われると解答に困るんだけど、
日頃から疑問に思ったことがあれば、まずドキュメントに
目を通すという習慣をつけてみたらどうだろう。
java でプログラミングしてて分からないことがあったら
まず javadoc を当たってみて、それでも分からなければ
ぐぐってみたりとか。
ツールのインストールの時も、まずは付属ドキュメント
(README, INSTALL みたいなやつ) に目を通すとか。
0576デフォルトの名無しさん
2008/05/02(金) 10:31:470577デフォルトの名無しさん
2008/05/03(土) 13:36:57遷移図は全体を出さずに、
ほげをするとBになります
A→B
ここでげほをするとCになります
A→B→C
ここでほれをするとAになり、やりなおしできます
A→B→C┐
←──┘
まあなんだ、たぶん図は崩れたと思うけど、インクリメンタルに
説明と共に図を成長させると理解してもらいやすい。
パワポのアニメで説明するとわかったきになるのに、
紙に出した同じ資料がわかりにくいのも同じ理由だと思う。
0578デフォルトの名無しさん
2008/05/06(火) 04:58:29>>575
遅くなったけど、ありがとう。
疑問を持ったら人に聞くクセをなくすように
がんばります。
0579デフォルトの名無しさん
2008/05/08(木) 17:47:02その前に勉強として、仕様書作ってプログラム作れって上司から
言われました。
プログラムは作ったことあるんですが、仕様書なんて作ったことありません。
常識的に考えたら、基本設計書、概要設計書、コード設計書とか全部作るべきでしょうか？
0580デフォルトの名無しさん
2008/05/08(木) 20:27:210581579
2008/05/08(木) 23:52:12言葉足らずですみません。
仕様書って何の事か聞いたんですが、自由に作っていいって言われたんです。
自由に作れと言われたら基本的な概要、機能とか画面構成など書けば仕様書としては
成り立つんだと思うんですが、いかんせん初めての経験なのでどのように書いたらいいか
わからないんですよね。
社会人の常識として設計書の本読んで基本設計書、概要設計書
など全ての設計書を作るのが妥当なのかという質問です。
0582デフォルトの名無しさん
2008/05/09(金) 00:08:070583デフォルトの名無しさん
2008/05/09(金) 03:44:010584デフォルトの名無しさん
2008/05/09(金) 08:08:02疲れたので途中で止めとくけど、こんな感じで読める読み物を作ればおけ。
ゴールの定義
・どういう背景があり（どういう歴史があり何で困っていたのか）
・何を実現したいと考えています（作ったものを使うことで得られると期待される効果のこと）
・このために何々をするものを作ることにしました
全体構造
・大きな制約条件として～がある中で（納期、コスト、現状からくる技術%A
0585デフォルトの名無しさん
2008/05/09(金) 08:09:41書き直すもの疲れたので諦めるすまん>>581
0586デフォルトの名無しさん
2008/05/09(金) 09:40:43・なんで作ったのか
・それを使ってどういう効果が期待できるか
・必要とする環境
・入力は何か
・出力は何か
競合するプログラムが既にある場合を除いて、
最初はどういう機能がとか、画面が云々とかは不要。
必要だといわれたら付け足していけば良いはず。
読む側にとってどうでもよさそうな事は極力避ける事。
つーか多分作ったのを後で添削するのが
意図なわけだから、あまり時間掛けると嫌われるぞ。
0587581
2008/05/09(金) 16:21:25入力、出力ってどういう意味ですか？
A4用紙一枚にまとめるのは変でしょうか？
0588デフォルトの名無しさん
2008/05/09(金) 16:40:36入力も出力もないプログラムは役に立たないだろう
記述が必要十分なら一文字にまとまっていても構わないぞ
0589581
2008/05/09(金) 17:00:35もしデータベースを扱うプログラムだったら、
どのようなデータを登録して（入力）、どのような形で表示するか（出力）
簡単に言えばこのような事でしょうか？
0590デフォルトの名無しさん
2008/05/09(金) 20:04:08ユーザーが入力して、プログラムがそれを計算する。（出力）
0591デフォルトの名無しさん
2008/05/10(土) 01:11:34社会人の常識とかじゃなくて、目的から考えた方がよいのでは
0592デフォルトの名無しさん
2008/05/10(土) 10:46:220593デフォルトの名無しさん
2008/05/10(土) 10:52:50クラス仕様の詳細じゃない部分
0594デフォルトの名無しさん
2008/05/10(土) 11:23:40・そのクラスの責任範囲と全体の中での役割
・超簡単なサンプル使用例
・データの流れと関与する主要APIを図示したもの（ポイントとなるクラスの場合）
これが１ページで欲しい所。
0595デフォルトの名無しさん
2008/05/26(月) 16:40:33PC:Windows XP
コンパイル方法:Visual Studio 2005のコマンドプロンプト上で、下記の命令をする
make msvc
C:\doxygen1.5.5 に doxygen1.5.5.src.tar.gz を解凍した中身を置きました。
C:\doxygen1.5.5\src のソースをいじって、コンパイルしましたがエラーが出てしまいます。
エラー内容
----
link /NOLOGO /LIBPATH:..\lib /SUBSYSTEM:console /OUT:..\bin\doxygen.exe
@C:\DOCUME~1\AA\LOCALS~1\Temp\nm2E.tmp
～
doxycfg.lib(portable.obj) : error LNK2019: 未解決の外部シンボル __imp__libiconv_open が関数 "void * __cdecl portable_iconv_open(char const *,char const *)" (?portable_iconv_open@@YAPAXPBD0@Z) で参照されました。
～
..\bin\doxygen.exe : fatal error LNK1120: 外部参照 5 が未解決です。
NMAKE : fatal error U1077: 'link' : リターン コード '0x460'
----
doxygenのソースのコンパイルは、下記以外に必要なものはありますか？
・Active perl
・GnuWin32のFlex
・Qt
・VC2005
・Microsoft Platform SDK
0596デフォルトの名無しさん
2008/05/26(月) 17:33:49エラーメッセージぐらい読めるようになったら？
0597595
2008/05/26(月) 18:28:33ありがとうございます。
iconv.lib,iconv.hがdoxygenのソース内に入っていたのでこれで良いのかと思っていました。
Libiconvをコンパイルしたものと差し替えたら、コンパイルが通過して下記ファイルが出来ました。
doxygen.exe
doxytag.exe
0598ura2ch.czsoftbank219174032071.bbtec.neta.net
2008/05/26(月) 18:33:080599デフォルトの名無しさん
2008/05/28(水) 23:41:27ソース内のコメントをちゃんと書け！
と思う、インフラ屋は俺だけではないはず。
特にリリース後の修正箇所に対して正確な
コメントが書かれているソースが本当に少ない。
頼むから引数のコメントくらい、まともに書いてくれ・・・・
0600デフォルトの名無しさん
2008/05/30(金) 04:18:140601デフォルトの名無しさん
2008/05/30(金) 13:08:410602デフォルトの名無しさん
2008/05/31(土) 00:23:06> 特にリリース後の修正箇所に対して正確な
> コメントが書かれているソースが本当に少ない。
これはコミットログやChangeLogの役目だろう
0603デフォルトの名無しさん
2008/05/31(土) 13:13:14ソース内のロジックとコメントは分業してるってこと？
ロジックとそのコメント内容が一致してないから
障害対応してるときに頭からソースを読まなければ
ならないってこと。
そして、修正したPGはすでにいないことが多い・・・・
0604デフォルトの名無しさん
2008/05/31(土) 17:32:04コメントとソースを同じように扱ってはいけないだろ
0605デフォルトの名無しさん
2008/05/31(土) 18:51:02ただ最初にも書いたけど、表題部の
プログラム名や用途、引数説明すら
まともに書いてないソースが多すぎる
からカキコしただけだ
0606デフォルトの名無しさん
2008/05/31(土) 19:19:501.5.5平気なんだけど
0607デフォルトの名無しさん
2008/05/31(土) 21:19:450608デフォルトの名無しさん
2008/05/31(土) 22:24:13> 特にリリース後の修正箇所に対して正確な
> コメントが書かれているソースが本当に少ない。
これは 「こう修正しました」 っていうコメントのことでしょ？
それはまさにコミットログ等の役割
コードからは読み取れない 「こういう処理です」 っていうのがコメントの役割だと思う
0609デフォルトの名無しさん
2008/06/01(日) 01:34:08"「こう修正しました」"は
ソース内の修正(変更)履歴のことを言ってる。
0610デフォルトの名無しさん
2008/06/01(日) 01:53:13そりゃあSCMがない時代の苦肉の策でしょ
0611デフォルトの名無しさん
2008/06/01(日) 09:06:34バージョン管理使おうぜ
0612デフォルトの名無しさん
2008/06/01(日) 11:47:08今、休出でVSS見てるけど、コミットログやChangeLogは存在しない。
各ソースのチェックインコメントは全部一緒で"○○○○更改に対する修正"・・・・
ほかに見るとこあれば教えてくれ。
（インフラ側で作ってる基盤モジュールのアップデート履歴のほうが
詳細に記載している。）
0613デフォルトの名無しさん
2008/06/01(日) 17:35:45履歴を残そうという意識が作業者に無ければコミットログにも残るわけ無いだろ。
お前んとこのローカルな事情だな、それは。
で、一般的に履歴を残すんならどっちかというとコミットログのほうが適切という話。
0614デフォルトの名無しさん
2008/06/01(日) 17:43:21コミットログはチェックインコメントと同じ意味
ツールが違うと用語が違う
チェックインコメントが全部一緒だと無意味だと感じませんか？
チェックインコメントは修正内容を記録するのにうってつけだと思いませんか？
0615デフォルトの名無しさん
2008/06/01(日) 17:49:07コミットログならすぐ探し出せる。コメント漏れがあっても差分を見つけられる。
コミットログに情報がないというのは、結局コメントの入れ方、運用の問題でしょ。
0616デフォルトの名無しさん
2008/06/01(日) 19:27:14みたいな感じに見えた
0617デフォルトの名無しさん
2008/06/02(月) 15:25:20http://pc11.2ch.net/test/read.cgi/tech/1212144627/
0618デフォルトの名無しさん
2008/07/27(日) 04:43:220619デフォルトの名無しさん
2008/08/23(土) 14:10:15じゃだめかな。
0620デフォルトの名無しさん
2008/08/23(土) 18:05:570621デフォルトの名無しさん
2008/11/17(月) 15:02:59どれがいいだろうか・・・
C++Builder2007なんだけど。どれ対応してるかもまだ調べてないんだ。
とりあえず・・・探すか。
0622デフォルトの名無しさん
2009/02/07(土) 11:48:29何か適当な代替え手段はないでしょうか？
# 何年ソフト屋やってんだ？ BNFくらい読めよ > 某メーカの糞 SE
0623デフォルトの名無しさん
2009/02/07(土) 12:29:550624デフォルトの名無しさん
2009/02/07(土) 12:32:070625デフォルトの名無しさん
2009/02/07(土) 13:16:45要所で適切な名前をつけて分割してあれば読みやすいし、
BNF知らなくても直感的にわかると思う。
逆に、１行でだらだら書かれたりすると、いくら正しくても読みづらい
0626デフォルトの名無しさん
2009/02/07(土) 14:43:47先生「意味が分からない．」
0627デフォルトの名無しさん
2009/02/07(土) 17:25:110628622
2009/02/07(土) 17:42:31条件指定できる設定ファイル用なので、そんなに巨大なツリーじゃない
そもそも, BNF の読み方を知らないらしい
>>627
Pascal の構文定義に使ってある奴？ あれって、けっこう一般的なの？
つか、BNF と変わらないような気もするが…
大量の使用例を書くしかないのか？
0629デフォルトの名無しさん
2009/02/07(土) 18:58:290630デフォルトの名無しさん
2009/02/07(土) 20:30:03xxx *= yyy | xxx yyy
を
項 xxx は、単独の yyy または xxx に続く yyy によって定義されます。
とかの半分機械的な置換で済むかもよ。
0631デフォルトの名無しさん
2009/02/07(土) 22:55:31BNF云々というより、人との付き合い方の問題な気がする
TPOとか判ってないでしょ
他人のオナニー文書を読まされる側の立場にもなってみろ
0632デフォルトの名無しさん
2009/02/08(日) 01:39:27書き手：「お前のオナニー用エロ文書を書かされる立場になってみろ」
読み手：「他人のオナニー文書を読まされる側の立場にもなってみろ」
不毛な・・・
0633デフォルトの名無しさん
2009/02/08(日) 01:52:160634デフォルトの名無しさん
2009/03/07(土) 12:45:090635デフォルトの名無しさん
2009/03/07(土) 21:27:240636デフォルトの名無しさん
2009/03/07(土) 21:52:54どんなに文字を尽くして書いても、相手の頭にすっと入ってイメージを
作れないと負け。
駄目なドキュメントって、たぶんすべて書いてあるんだろうけど
量ばかり多くてツマラン推理小説みたい。筋の5W1Hがさっぱり見えないで
筋書きを楽しむ以前に何がなんだかわからないオナニーみたいなやつ。
0637デフォルトの名無しさん
2009/03/14(土) 03:43:34見せ合いっこはｺｰﾌﾝする
0638デフォルトの名無しさん
2009/04/10(金) 18:21:150639デフォルトの名無しさん
2009/04/12(日) 14:23:360640デフォルトの名無しさん
2009/06/13(土) 08:57:14学習目的で小さなプロジェクトを立ち上げようと思っているのですが、
各種ドキュメント（基本設計、詳細設計、テスト仕様書等）の雛形、規格のようなものは
どこかで公開されていないのでしょうか？
IEEEって団体が作ったものがあるようですが
無料ですぐに手に入るものではないようです。
他にどこか有名な団体が作成したものがあるでしょうか。
できれば日本語が好ましいです。
よろしくお願いします m(__)m
0641デフォルトの名無しさん
2009/06/15(月) 11:53:08行く場所場所でドキュメントの定義やスコープ、はたまた名称まで違ってて毎回混乱・・。
その場所のしきたりに慣れるまでストレスを追わにゃぁならん。
プロジェクトの規模にもよるから当然ちゃ当然だが、ドキュメント類は
大まかな指針のようなものに従って書いてもらいたいし、書きたいわけだ。
どこかの学者様かスーパーＳＥ様あたりが統一規格のようなものを打ち出してくれて、
それが広まってくれれば助かるんだがな。
0642デフォルトの名無しさん
2009/06/15(月) 12:47:00そもそも用語でさえベンダ間で互換性がないんだから、どうしようもないな。
0643デフォルトの名無しさん
2009/06/15(月) 16:25:34であるならば、新規プロジェクトを起こす場合、最大公約数的な雛形となるべき指針が
存在してもいいはずだと思わんでもない。
ま、下請けが納品する場合はどうあがいても、大手のフォーマットを利用せざるを得んのだろうが・・。
ちょっと探してみたんだが
ttp://www.hotdocument.net/
↑あたりはなにかしらのフォーマットを利用したんだろうか？
0644デフォルトの名無しさん
2009/06/15(月) 19:02:04普通そこらに転がってるドキュメントって、
＊＊＊ このように、できてます！！！ ＊＊＊ が、書いてあるだけで
＊＊＊このように作らなければならない理由＊＊＊ が、書いてない。
＊＊＊もっと上の仕様書との連続性もない＊＊＊ 場合がほとんど。
なので、メンテナンスの役に立たない。
0645デフォルトの名無しさん
2009/06/15(月) 21:11:58大手ベンダが専門の標準化チーム作ってフォーマットをガリガリつくってんのが現状。
派遣ソルジャーがデータ持ち出さない限り表にゃあ出てこねえよ。
0646デフォルトの名無しさん
2009/06/16(火) 06:58:09発注者視点ですが、開発者でも使えると思う。
0647デフォルトの名無しさん
2009/06/16(火) 14:37:32ttp://www.sage-p.com/process/process.htm
俺めんどくさいから目通してないがｗ
0648デフォルトの名無しさん
2009/06/16(火) 17:10:390649デフォルトの名無しさん
2009/06/16(火) 23:38:52■ このスレッドは過去ログ倉庫に格納されています