[表示 : 全て 最新50 1-99 101- 201- 301- 401- 501- 601- 2chのread.cgiへ]
Update time : 11/06 07:03 / Filesize : 155 KB / Number-of Response : 622
[このスレッドの書き込みを削除する]
[+板 最近立ったスレ&熱いスレ一覧 : +板 最近立ったスレ/記者別一覧] [類似スレッド一覧]


↑キャッシュ検索、類似スレ動作を修正しました、ご迷惑をお掛けしました

良いドキュメント・マニュアル・仕様書を書くスレ



1 名前:デフォルトの名無しさん [03/10/05 23:34]
おまえら、自分で作ったプログラムについての、わかりやすく的確な
ドキュメントを書ける自信はあるか?
仕事で納品したり、他人に見せるプログラムとして公開するつもりなら、
マニュアルや、仕様書などのドキュメントを書く機会は必ずある。

プログラムとドキュメントはとても関係が深い。ドキュメントが整っていない
プログラムなど、ゴミと同じ。それに、ただ書けばいいって物でもない。
ドキュメントがゴミ程の役にも立たなければ、結局それはゴミなのだ。
だらだらと書いた意味不明な文章を他人に見られるのも恥ずかしいよな?

いわばドキュメントを書く技術はプログラマの必須スキルの1つなのだが、
実際は、下手糞なドキュメントが蔓延っている。(これはGNU製に多い)
読んでも無駄とか、書いても無駄とか思ってる奴、その考えを改めろ。
プログラムに対するドキュメントを、ちゃんとした1作品として、
後世に残せるよう努力すべきだろう。

今一度問う。
おまえら、わかりやすく的確なドキュメントを書ける自信はあるか?


116 名前:110 mailto:sage [03/10/30 08:45]
>111
あ、そういう事か。
図を抜く訳ね。
てっきり「一般的にはみかんと呼ばれる物を俺のところではりんごと呼んでいた」
くらい違うのかと思ってた。
今後気をつける。

117 名前:デフォルトの名無しさん [03/10/30 10:00]
>>114
当然相手に応じて。

言われなければ俺は
回路図とかの図面はPDFにして
テキストで書ける事は全部ソースに全部埋め込む。



118 名前:112 [03/10/30 22:22]
>>113
どうやんのって、持ってるならヘルプ見れよ!!!
今回だけだぞ、
[ファイル]−[版の管理...]

119 名前:デフォルトの名無しさん mailto:sage [03/10/31 01:07]
ドキュメントのメンテ工数もらえないうちらはどうすればよいでしょうか

120 名前:デフォルトの名無しさん mailto:sage [03/10/31 12:07]
その分別工程に上乗せ。

121 名前:デフォルトの名無しさん [03/11/21 23:23]
Doxygen Release 1.3.5 age

122 名前:デフォルトの名無しさん mailto:sage [03/11/22 13:45]
DoxygenでXHTMLを吐く上手い方法はないかね?

123 名前:デフォルトの名無しさん mailto:sage [03/11/22 17:58]
Doxygenの出力パーサを弄くるとか。
あれってC++だっけ?
Doxygenレベルのlexerが単体で使えれば楽になることが沢山あるんだが・・。

124 名前:デフォルトの名無しさん [04/02/17 16:19]
仕様書ってーか、目論見書つくらんといけなかったのですが、
windowsのアプリ完成後のイメージを作成するのに、
簡単にコントロールぺタぺタできるのありませんかね?
VCのダイアログボックスも、VBのダイアログボックスもめんどくさいとこあるし・・・。
どなたか良いのありましたら教えてください。



125 名前:デフォルトの名無しさん mailto:sage [04/02/18 00:59]
目論見書って、金融の目論見書しか知らないんだけど。

その目論見書?
それにWindows の UI を乗せる必要がある?

126 名前:デフォルトの名無しさん [04/02/18 09:21]
>>125
レスありがとうございます。

なんつーんでしょうかね?まぁ、こんなん作りますがみたいなのを他社に送るもんらしいです。
まぁ、中身も当然ですがUIの使いかってがかなり重要っぽいので・・・。
もう、フリーハンドでもいいとおもうんですけどね・・・。
とりあえず、今回はまぁそれなりに書いたんでどね。
次回以降ワードあたりでしこしこ線引くのも疲れるんで、なんか楽なの無いかな?と思いまして・・・。

127 名前:デフォルトの名無しさん mailto:sage [04/02/18 20:18]
Visioなら書けるが、VC・VBの方が楽。よってVisioでは無理。

128 名前:デフォルトの名無しさん [04/02/18 21:45]
>>127
wxWindowsのGUIツールキットBOAとかFOXとかFLTKあたりで作成できないもんかと思って、
とりあえず、暇できたらなんか色々チャレンジしてみます。
でも、.NET対応流行ったらどうすっぺ・・・。

129 名前:デフォルトの名無しさん mailto:sage [04/02/18 22:36]
FLTKは日本語まわりがアレ、wxWindowはちょっとDLLがデカイ
gtk+ 導入するのにものすごい壁がある。 Foxは知らん。
なんとなく実用的なものならwxWindowがいい、
でもどれでもポトペタは無理だと思う。


130 名前:デフォルトの名無しさん mailto:sage [04/02/18 22:44]
ポトペタってなに?

131 名前:デフォルトの名無しさん mailto:sage [04/02/18 23:15]
>>126
俺の会社の先輩はPowerPoint使ってデモしてました。
文字入力画面はできない(アニメーションでやってた)みたいだけど、
ボタンと画面表示はリンクで適当に作ってました。
全画面表示のアプリで、それっぽく見せてましたよ。

132 名前:デフォルトの名無しさん mailto:sage [04/02/18 23:42]
まぁVBが一番楽なんだろうね。

133 名前:デフォルトの名無しさん mailto:sage [04/02/19 01:56]
画面設計書じゃないから、それこそ"○○部分"と書いた枠の配置だけでいいと思う。
というか、そうでもして抽象化しないと完成画面だと思われる。

はっきりいえば、Windows の画面かどうかも分からないように書いたほうがいい。


134 名前:デフォルトの名無しさん mailto:sage [04/02/19 06:20]
もしもしTcl/Tkを忘れてますよ



135 名前:124 mailto:sage [04/02/19 09:35]
>>129-134
みなさまどーもありとうございます。

>>129,132
ポトペタ(ポトッとおとしてペたって貼り付け?)は無理ですか。
VBで適当につくるのがいいんですかね・・・。
でもおいらVB苦手っす(なんかめんどいからかな?)。
超初心者用ページでいいページないですかね(スレ違い)。
C++ならそれなりにモウマンタイって感じなんですけど。

>>131
パワーポイントっすか。使ったことないですね。考慮してみます。

>>133
うーむ、画面設計書とかそこらへんの違いよくわからないです。
そういうのわかる書籍とかページありませんか?(スレ違い?)
とりあえず、今度は抽象化してだしてみますね。

>>134
あ、どもです。とあるページに載ってなかったもんでメジャーではないのかと思いまして。
(ここのGUIスレには載ってますけど)

136 名前:デフォルトの名無しさん mailto:sage [04/02/26 23:15]
末端プログラマしかやったことないんですが、
ちょっとPMで設計書の類(まだはっきりしてないけど)を書く必要にせまられました。

で、役立つオススメな本あります?

137 名前:デフォルトの名無しさん mailto:sage [04/02/27 22:42]
まず、身の周りに先輩達が書いた設計書(見本)がないか探してみる。
なかったり、どうしようもないような代物なら…ガンガレ。

プログラム 設計書 で ぐぐると合うような物が見つかるかもよ。


138 名前:デフォルトの名無しさん mailto:sage [04/02/27 22:47]
周りに先輩達が書いた設計書(見本)がないか探してみる。
なかったり、どうしようもない代物だったら…ガンガレ。

プログラム 設計書 でぐぐる
要求定義からやる羽目になる罠もあるのでその辺もひっかけておく。


139 名前:デフォルトの名無しさん mailto:sage [04/02/27 22:50]
二重カキコ。逝って(ry
_| ̄|○

140 名前:(゜Jし゜) mailto:sage [04/02/27 23:55]
www.seshop.com/detail.asp?pid=4448

このへんどうよ?

141 名前:136 mailto:sage [04/02/28 05:24]
>>137-139
ありがとうございます。あさってみます。

>>140
ありがとうございます。アキバのラオックスで立ち読みして、よさそうならかってきます。

142 名前:http://bulkfeeds.net/app/search2?q=UML [04/03/31 00:03]
UML・仕様書・設計書関連2chスレッドのまとめ (siyousyo - wikich)

pwiki.chbox.com/pukiwiki.php?siyousyo


bulkfeeds.net/app/search2?q=UML

143 名前:デフォルトの名無しさん [04/05/11 00:16]
doxygen 1.3.7 age

144 名前:デフォルトの名無しさん [04/07/18 17:51]
詳細設計書は、プログラム処理の羅列でいいんだよね?



145 名前:デフォルトの名無しさん mailto:sage [04/07/20 02:43]
>プログラム処理の羅列

ダメ、それはプログラム設計書だNe!

146 名前:デフォルトの名無しさん [04/07/25 19:54]
doxygen 1.3.8 age

147 名前:デフォルトの名無しさん mailto:sage [04/09/11 00:13:39]
142さんありがとうございます。助かりました。
激遅レスだけど、感謝です。

148 名前:あげ [04/09/25 05:02:40]
doxygenで複数の言語向けのドキュメントを書くにはどうすればよいのだろう?

149 名前:デフォルトの名無しさん [04/09/25 05:06:02]
www.npb.or.jp/

150 名前:148 mailto:sage [04/09/25 05:09:09]
すまん。
doxygen+"two languages"でぐぐったらマニュアルの\ifディレクティブの項に書いてある事が分かった。

151 名前:デフォルトの名無しさん mailto:sage [04/09/28 16:09:35]
保守

152 名前:デフォルトの名無しさん [04/10/06 23:25:55]
運用マニュアルや仕様書だの、どこか公的な書き方の決まりはあるんでしょうか。
例えばメニュー名などはどういう括弧でくくるのか、単語末の長音はない
方がいいとか、会社とかによってルールとかはあるとは思うんですが…。
でもまちまちだとどこか新しい営業先に提案書持っていくときだの、いろんな
会社のマニュアルを保管する側とかとまどったりするんじゃないかと
思うのですが、みなさんは普通に自分の周辺ルールで書いてますか?

153 名前:デフォルトの名無しさん [04/10/07 01:12:28]
doxygen 1.3.9 age

154 名前:デフォルトの名無しさん mailto:sage [04/10/07 01:18:23]
>>152
今までマニュアルや仕様書を(良い悪いに関わらず)読んできた経験に基づいて決める。
どこでも見かけるルールには従う。
あ、このルールいいな、と思ったものは取り入れてみる。
このルールだめじゃん、と思ったものは自分ではそうならないように気をつける。
ま、毒にも薬にもならん意見だな。

「ドキュメント」「標準」とかをキーに検索すれば?



155 名前:デフォルトの名無しさん [04/10/07 23:01:14]
俺も結局わからないまま、ウケよかったからいいか…とか
先例でいい奴とかまねしてるが、業界として共通の表現とかって
どっかないんかな…

156 名前:デフォルトの名無しさん mailto:sage [04/10/07 23:10:44]
この調子ではどうせ読む奴もわからないからいいんじゃない

157 名前:デフォルトの名無しさん mailto:sage [04/10/08 06:09:48]
どうせ誰も読まないから適当でいいんじゃない

158 名前:デフォルトの名無しさん [04/10/13 00:00:55]
doxygne 1.3.9.1 age

159 名前:デフォルトの名無しさん mailto:sage [04/10/13 01:09:00]
doxygenやJavaDocは多言語対応まで視野に含めると、どうかなと思ったり。


160 名前:デフォルトの名無しさん mailto:sage [04/10/13 01:58:22]
>>159 詳しく

161 名前:デフォルトの名無しさん mailto:sage [04/10/13 07:55:33]
>>159
INPUT_FILTER使えば?

162 名前:デフォルトの名無しさん mailto:sage [04/10/13 17:55:43]
俺ぐらいのレベルだと
ソースがドキュメント

163 名前:デフォルトの名無しさん mailto:sage [04/10/13 17:56:44]
ドキュメントが嘘ついている場合もあるのだ。

164 名前:デフォルトの名無しさん mailto:sage [04/10/13 21:45:34]
>>162のソースは嘘をついている



165 名前:デフォルトの名無しさん mailto:sage [04/10/13 21:49:15]
ソースがドキュメントと言っている奴のソースは大抵糞。
俺のソースはきれいだと腐ったソースで自分に酔ってる厨と同じ。

166 名前:デフォルトの名無しさん mailto:sage [04/10/13 22:08:47]
腐ったソースで走り出す♪
(プロジェクトが)

167 名前:デフォルトの名無しさん mailto:sage [04/10/13 22:33:25]
warota

168 名前:Ruby!!!!!!!!!!!!!! mailto:sage [04/10/13 22:35:09]
まつもとゆきひろ尊師は「ソースがドキュメント。バグもそこに記述されている」と仰いました。
おまえらひれ伏せ。

169 名前:デフォルトの名無しさん mailto:sage [04/10/14 00:53:52]
#if 0
ドキュメントはソースだけで十分です。
#endif


170 名前:デフォルトの名無しさん mailto:sage [04/10/14 11:46:15]
×ドキュメントはソースだけで十分です。
○ドキュメントはソースだけしかありません。

171 名前:162==163 mailto:sage [04/10/15 12:47:21]
>>164-166
いや、
おれが、ドキュメント書かないわけじゃないよ。
一応気を使ってdoxygen対応で書いてるぜ。

で、
わかりにくいドキュメント見るぐらいなら、ソース見るって感じ。

ドキュメント読んで信じて、騙されるぐらいなら
ソースを読んだ方が正確。時間もさほど変わらない。←これが俺ぐらいのレベル

ソースが汚い奴のドキュメントは、
やっぱりわかりにくい罠ってのもある。

一応、EffectiveC++レベル以上のその系統の書籍を数冊読んでるし、
汚いソース何個も見てきたので
ある程度の読みやすいソース書く自信あるぜ。
そういう本読んでない初心者ちゃんにはきついかも。

172 名前:デフォルトの名無しさん mailto:sage [04/10/15 15:14:32]
ソースだけだと仕様なのか脆弱性なのかバグなのか区別がつかん。
ソース自体が読みやすいとか読みにくいとは全く別問題だし。

自分のソースにはバグは一切無いとか、
仕様のためのコードなのか、高速化のためのコードなのか、単にダメっぽいコードなのか、
みたいのを誰が見ても一目瞭然で区別できるとかいうなら話は別だが。

173 名前:デフォルトの名無しさん [04/10/17 07:34:17]
サルベージ

174 名前:デフォルトの名無しさん mailto:sage [04/10/31 22:59:23]
ドキュメントがメンテされてなくて役に立たん、というのはよくある話だ。



175 名前:デフォルトの名無しさん mailto:sage [04/10/31 23:06:43]
ドキュメント更新まで含めてコーディングすればいい

176 名前:デフォルトの名無しさん mailto:sage [04/11/03 15:51:12]
ドキュメントは古参SEの頭の中だけってプロジェクトもあるよねえ(溜息)

177 名前:デフォルトの名無しさん [04/11/23 20:57:53]
今日Doxygen使い始めた。教科書はCマガジンの2002/8とDoxygenヘルプ。

*.hにコメント書くよりも*.cppに書いたほうが良い、というのは理解した。
(そりゃそーだわな)

でも、DLLなどのバイナリライブラリでソース見せたくないときは、
*.hに書くしかないような気がする。

*.cppに書いてあったコメントが、あたかも*.hに書いてあったように
Doxygenできる方法ってあるの?

それともローテクにリリース寸前でコメントを*.hにコピペするんか?

178 名前:デフォルトの名無しさん mailto:sage [04/11/23 21:01:35]
おれ177
まだまだ使い始めだからわかってないのかもしれないが、
要は、ソースが丸見えになるのがいやなのだ。
ソースを隠すオプションが探し切れていないだけなのかもしれん。

179 名前:デフォルトの名無しさん mailto:sage [04/11/23 23:23:10]
>>177
Doxygenした結果はcppに書いてあろうがhに書いてあろうが同じだと思うが。
ソース隠すオプションはある。

180 名前:デフォルトの名無しさん mailto:sage [04/11/24 15:01:58]
というかデフォルトで隠されてたような。
WindowsならDoxyWizard使うと楽チン。

181 名前:デフォルトの名無しさん mailto:sage [04/11/24 19:01:47]
おれ177
すまんかった、いろいろ試してみたらソース隠せたよ。
DoxyWizardは知らんかった、ちょっとさわってみる。

182 名前:デフォルトの名無しさん [05/01/03 15:58:41]
doxygne 1.4.0 age

183 名前:ライブラリアン [05/01/03 16:36:26]
ドキュメントってプログラミングする前に
書くものじゃないの。仕様書とか検査成績書とか。
プロはドキュメントを書いている時点で情報不足や矛盾が
わかるのでしょう。
プログラムを作ってからドキュメントを作るのは
最低だな。ゲーム少年の域をこえてないよ。


184 名前:デフォルトの名無しさん [05/01/03 18:44:34]
cppdocもソースやヘッダーの内容を文書化するのに使える



185 名前:デフォルトの名無しさん mailto:sage [05/01/03 19:00:47]
>>183 うるせーばか

186 名前:デフォルトの名無しさん mailto:sage [05/01/03 21:42:33]
>>183は真のゲーム少年

187 名前:デフォルトの名無しさん mailto:sage [05/01/03 22:07:53]
まず「ゲーム少年」というのが何だかよくわからないな

188 名前:デフォルトの名無しさん mailto:sage [05/01/03 23:36:12]
>>183
おいらのとこでは、プログラマが書くのは保守ドキュメントのほうが多い。
そうするとあとで書いたほうがいい。
同時にかくのはもっといい。
仕様書、成績書は別の人間が書く。
同じ人間がかくってことは零細?


189 名前:デフォルトの名無しさん mailto:sage [05/01/03 23:38:38]
零細の何が悪い

190 名前:デフォルトの名無しさん mailto:sage [05/01/04 00:00:46]
誰が書く、ということではなく
書く順番の話をしているのでは
ということは188は読解力ゼロ?


191 名前:デフォルトの名無しさん mailto:sage [05/01/04 01:47:32]
属人性MAX

192 名前:188 mailto:sage [05/01/04 23:28:28]
>>190
プログラマの文書は保守文書が多かろうから
あとか同時に書くほうがいいし、あとが駄目とは
言い切れないんじゃないのということが言いたかった
ですよ。
んで、矛盾を見つかる仕様書は別の人が
書くだろうからそれで、非プロとはいかがなものかと。

>>189
悪くないけど大変ですね。

193 名前:デフォルトの名無しさん mailto:sage [05/02/08 23:36:23 ]

doxygenのLaTeX出力は鬼門だな

ttp://www.atmarkit.co.jp/bbs/phpBB/viewtopic.php?topic=8354&forum=3&2
この辺のでサンプルは上手く逝ったが、漏れのソースだとイヒけ杉

194 名前:デフォルトの名無しさん mailto:sage [05/02/09 15:13:57 ]
要件定義書でのデータモデルって、良いお手本ありますかね?
概念モデルで。



195 名前:デフォルトの名無しさん [2005/04/09(土) 19:20:51 ]
doxygen 1.4.2 age

196 名前:デフォルトの名無しさん mailto:sage [2005/05/08(日) 01:04:55 ]
doxygenで、ローカル変数のコメントを出力するにはどうすりゃいいんすか?

int main(void){
 char s[BUFSIZE]; //!汎用バッファ
 ↑こんなやつ。


197 名前:デフォルトの名無しさん [2005/05/08(日) 01:11:53 ]
>>196
ローカル変数を廃止して、全部グローバルにすればOK?



198 名前:デフォルトの名無しさん [2005/05/08(日) 01:14:38 ]
FLH1Ach124.kng.mesh.ad.jp/
wwwwwwwwwwwwおkwwwうはっwww
うぇwww
おkwwwっっおkwwwwwwwwww


wwwうぇwwwwwwwwwwwwwwwwww


199 名前:デフォルトの名無しさん [2005/05/08(日) 01:28:10 ]
YahooBB219215164084.bbtec.net/
おkwwwっっおkwwwっうぇうぇwww

うはっwww
っwwwwwwwwwwww
っうぇwwwwww
うはっwwwっうぇwwwwwwwwwwwwwww

200 名前:デフォルトの名無しさん mailto:sage [2005/05/08(日) 23:37:07 ]
>>196
そんなもの出力する必要あるの?

201 名前:デフォルトの名無しさん [2005/05/08(日) 23:48:31 ]
>>200
変数のドキュメントは必要でしょー


202 名前:デフォルトの名無しさん mailto:sage [2005/05/08(日) 23:50:12 ]
えーだってローカル変数だよ?
doxygenって、関数やクラスのインタフェースを記述するためのものじゃないの?

203 名前:デフォルトの名無しさん [2005/05/09(月) 11:15:06 ]
>>202
きめつけ:(・A・)イクナイ

204 名前:デフォルトの名無しさん mailto:sage [2005/05/09(月) 11:27:33 ]
>>203
ローカル変数ってのは隠蔽されるべきものなので、
皆が読むドキュメントには書くべきではないと思われ。

実装者とか保守する人用に注意書き程度にコメント書くなら構わんと思うけど。



205 名前:デフォルトの名無しさん mailto:sage [2005/05/09(月) 11:54:51 ]
意味不明文書が大量生産されるのは
じつわ
ぜんぶmadeinusa
なので
それを
にほんごにするときに∞∴♂♀℃¥$¢£%#&*@§☆

206 名前:デフォルトの名無しさん [2005/05/09(月) 12:07:04 ]
ntchba046149.chba.nt.ftth.ppp.infoweb.ne.jp/

おkwwwうはっwwwwwwおkwww
wwwwwwwwwwww
っうぇ
wwwwwwwwwwww
うはっwwwおkwwwwwwwwwwwwwっうぇ


207 名前:デフォルトの名無しさん mailto:sage [2005/05/10(火) 00:19:54 ]
>>204
保守用ドキュメントを作成し

208 名前:デフォルトの名無しさん [2005/05/10(火) 02:08:45 ]
>>207
普通は意味無いので

209 名前:デフォルトの名無しさん [2005/05/10(火) 02:30:03 ]
pl070.nas931.nara.nttpc.ne.jp/
wwwwwwwwwwwwwうはっwwwwwwww

wwwっwwwwwwwwwwwwwww
おkwww
うはっwwwwwwうぇwww
wwwwwwwwwwww

210 名前:デフォルトの名無しさん [2005/05/10(火) 03:33:47 ]
218.33.211.112.eo.eaccess.ne.jp/
おkwwwうぇwwwwwwwwwwwwwwwうはっwww
うぇwwwwwうはっwwwwwwwwwwwwwww
wwwwwwwwwwうはっwwwwwwうぇwww

211 名前:デフォルトの名無しさん mailto:sage [2005/05/11(水) 08:37:36 ]
↑あげると、こうなるので、上げないように。



212 名前:デフォルトの名無しさん mailto:sage [2005/05/11(水) 20:58:44 ]
だが断る

213 名前:デフォルトの名無しさん mailto:sage [2005/05/12(木) 09:26:54 ]
だがそれがいい

214 名前:デフォルトの名無しさん mailto:sage [2005/05/12(木) 22:50:48 ]
だが断る



215 名前:デフォルトの名無しさん mailto:sage [2005/05/13(金) 09:19:26 ]
だがそれがいい

216 名前:デフォルトの名無しさん mailto:sage [2005/05/13(金) 18:14:50 ]
俺たちの青春かよ!






[ 続きを読む ] / [ 携帯版 ]

前100 次100 最新50 [ このスレをブックマーク! 携帯に送る ] 2chのread.cgiへ
[+板 最近立ったスレ&熱いスレ一覧 : +板 最近立ったスレ/記者別一覧]( ´∀`)<155KB

read.cgi ver5.27 [feat.BBS2 +1.6] / e.0.2 (02/09/03) / eucaly.net products.
担当:undef